Skip to content

Getting Started

This section will guide you through the steps required to install, configure, and use Daytona to manage your development environments.

Before You Begin

Before installing and using Daytona, ensure that your operating system meets the necessary requirements, dependencies and tools.

System requirements

Daytona supports multiple operating systems and architectures. Ensure your system matches one the following specifications:

Operating SystemArchitecture
Linuxx86_64 or ARM64
macOSx86_64 (Intel-based) or ARM64 (Apple Silicon)
Windowsx86_64 or ARM64

Dependencies

Daytona requires specific dependencies to be installed on your system to support the operation and management of your development environments. Ensure these dependencies are installed and properly configured on your system:

DependencyDescription
DockerDaytona uses Docker to create and manage isolated development environments.
Administrator PrivilegesEnsure that you have the necessary permissions to install and configure Daytona on your system.

Tools

Daytona requires certain tools to be installed on your system to optimize the setup and management of development environments. Ensure these tools are installed and properly configured on your system:

ToolDescription
Text Editor / IDERecommended for editing configuration files and working with code within Daytona Workspaces.
SSH ClientRequired for accessing remote servers, especially if deploying Workspaces on a remote Docker installation or accessing remote Git repositories.

Installing Daytona

Follow the instructions provided in the installation guide to install Daytona on your operating system. The guide includes detailed steps for installing Daytona on Linux, macOS, and Windows operating systems.

The installation process may vary depending on your operating system and specific environment. Refer to the guide for comprehensive instructions tailored to your setup.

Once you have completed the installation, you will be ready to start using Daytona to manage and develop your development environments. If you encounter any issues during installation, consult by reaching out to Daytona’s Slack community for assistance.

Using the CLI

The Daytona Command-Line Interface (CLI) is the primary method of interacting with the Daytona platform. The CLI provides a comprehensive set of commands that allow you to manage Workspaces, Providers, and other system configurations.

To access the Daytona CLI, open your terminal and use the daytona command followed by the desired subcommand. The CLI offers a wide range of commands, each serving a specific purpose, such as creating Workspaces, managing Providers, setting Targets, and configuring system settings.

For a complete list of available commands and their descriptions, refer to the CLI Reference. This reference guide provides detailed information on each command, including usage examples and command options, helping you leverage the full potential of the Daytona CLI.

Additionally, you can use the daytona --help command to list all commands, offering a convenient way to explore available options.

Adding a Git Provider

You can integrate Daytona with a Git Provider to manage version control operations and interact with your Git repositories.

Daytona supports a variety of Git Providers, including GitHub, GitLab, Bitbucket, GitHub Enterprise Server, GitLab Self-Managed, Bitbucket Server, Codeberg, Gitea, Gitness, Azure DevOps, and AWS CodeCommit.

This integration supports and enables interacting with your codebase, cloning repositories, and pushing changes directly from Daytona.


Use the daytona git-providers --help command to view available options for managing your Git Provider configurations and interacting with your repositories.

Installing a Provider

Providers are plugins through which Daytona integrates with various technologies to create and manage development environments. Providers abstract complexities of underlying technologies and serve as the foundational engines that Daytona leverages to deploy and run your environments, whether through containerization, orchestration, or cloud-based virtual machines.

By default, a Docker Provider is configured with localhost as the Target.

  1. Run the following command to install a Provider:
Terminal window
daytona provider install
  1. Select the Docker Provider you want to install from the list.
Choose a provider to install
1 item
===
docker-provider
v0.0.0

Upon selecting the Provider, Daytona will install and configure the chosen Provider, making it available for managing and deploying development environments.

Provider docker-provider has been successfully installed

If this configuration meets your requirements, you can proceed with setting a Target.

You can install additional Providers to extend Daytona’s capabilities and support a wide range of container management platforms and cloud hosting services.

Follow the instructions provided in the Providers installation guide to install and manage a Provider. The guide includes detailed steps for installing Providers for various container management platforms and cloud hosting services.

Setting a Target

A Target refers to the specific destination or environment where your development setups, facilitated by various Providers, are deployed and managed. Providers define the method and technology used to create your environments, while Targets specify the precise location or platform where these environments will reside.

A Target can be a local machine, a remote server, or a cloud instance, and it can vary based on the chosen Provider. Targets offer the flexibility to deploy and manage environments across different platforms and accounts, all within the unified interface provided by Daytona.

Once you set your Target, it becomes available for selection whenever you create a new development environment in Daytona. You can manage multiple Targets or delete those you no longer need.

Follow the instructions provided in the managing Targets guide to set a Target and configure your development environment deployment settings.

Use the daytona target --help command to view available configuration options for setting a Target.

Choosing the Default IDE

Daytona allows you to connect to your development environment using a variety of IDEs, including popular options like Visual Studio Code (VSCode), JetBrains IDEs, and Terminal SSH.

By setting the default IDE, you can automatically open your development environment in your preferred environment, optimizing your workflow and reducing setup time.


Use the daytona ide command to view available configuration options for setting the default IDE.

Creating your Workspace

Once you have completed the initial setup and configuration steps, you can create your Workspace using Daytona. A Workspace represents an isolated development environment where you can manage your code, build projects, and collaborate with team members.

Creating a Workspace involves defining the necessary configurations, such as selecting the appropriate Git Provider or entering the Git repository URL. Daytona simplifies this process by providing a user-friendly interface to set up and manage your Workspaces.

To create a Workspace, use the daytona create command and follow the prompts to configure your Workspace settings. Once created, you can access your Workspace and interact with your codebase.