daytonaio / daytona

Workspace Management

The Daytona CLI provides a set of commands for managing workspaces within a Daytona environment. Workspaces are containers for multiple projects and are managed through an API.

Using the Daytona CLI

The daytona command is used to interact with workspaces. It accepts flags to control output format and verbosity.

daytona [flags]

Available Flags

  • -o, --output string: Specifies the output format. Options include “yaml” and “json”.
  • --help: Displays help information for the command.

Examples

  • List workspaces in JSON format: daytona list -o json
  • Start a workspace named “my-workspace”: daytona start my-workspace

Commands

  • daytona agent: Starts the agent process for the workspace.
  • daytona autocomplete: Adds completion scripts to your shell environment for the Daytona CLI.
  • daytona docs: Opens the Daytona documentation in your default browser.
  • daytona forward: Forwards a port from the project to your local machine.
  • daytona info: Displays information about the current workspace.
  • daytona list: Lists all workspaces.
  • daytona start: Starts the project within the workspace.
  • daytona stop: Stops the project within the workspace.
  • daytona version: Prints the version number of the Daytona CLI.

Workspace Management API

The API for managing workspaces provides a set of endpoints for creating, retrieving, listing, deleting, and managing the state of workspaces and their associated projects.

  • CreateWorkspace: Creates a new workspace.
  • GetWorkspace: Retrieves information about a specific workspace.
  • ListWorkspaces: Lists all available workspaces.
  • RemoveWorkspace: Deletes a workspace.
  • SetProjectState: Sets the state of a project within a workspace.
  • StartProject: Starts a project within a workspace.
  • StartWorkspace: Starts all projects within a workspace.
  • StopProject: Stops a project within a workspace.
  • StopWorkspace: Stops all projects within a workspace.

API Documentation

For detailed information about the Workspace API, please refer to:

Command-Specific Documentation

For additional information on specific commands, consult the following documentation pages:

Top-Level Directory Explanations

cmd/ - Contains command-line interface tools and scripts.

internal/ - Private package directory for the project’s internal modules.

internal/testing/ - Subdirectory for testing-related modules.

internal/testing/server/ - Subdirectory for testing server configurations.

internal/util/ - Subdirectory for utility modules.

pkg/ - Go packages directory.

pkg/api/ - Subdirectory for API-related packages.

pkg/api/controllers/ - Subdirectory for API controller handlers.

pkg/apiclient/ - Subdirectory for API client package.

pkg/cmd/ - Subdirectory for command-line interface tools.

pkg/cmd/workspace/ - Subdirectory for workspace command-line tools.

pkg/cmd/workspacemode/ - Subdirectory for workspace mode command-line tools.

pkg/db/ - Subdirectory for database-related packages and scripts.

pkg/db/dto/ - Subdirectory for database data transfer objects.

pkg/server/ - Subdirectory for server-related packages and scripts.

pkg/server/workspaces/ - Subdirectory for workspaces server-side.

pkg/views/ - Subdirectory for view templates.

Entrypoints and Where to Start

cmd/daytona/main.go - This is the main entrypoint of the Daytona application. The ‘main’ function initializes the application and starts the server. The ‘init’ function is used for initialization tasks such as setting up logging and loading configuration files.