Daytona Ruby SDK

The official Ruby SDK for Daytona, a secure and elastic infrastructure for running AI-generated code. Daytona provides full composable computers — sandboxes — that you can manage programmatically using the Daytona SDK.

The SDK provides an interface for sandbox management, file system operations, Git operations, language server protocol support, process and code execution, and computer use. For more information, see the documentation.

Installation

Requires Ruby >= 3.2. Check your version with ruby -v before installing — on older versions the install fails with a Bundler/RubyGems resolver error rather than a clear message.

Install the package using gem:

gem install daytona

or add it to your Gemfile:

gem 'daytona'

Get API key

Generate an API key from the Daytona Dashboard ↗ to authenticate SDK requests and access Daytona services. For more information, see the API keys documentation.

Configuration

Configure the SDK using environment variables or by passing a configuration object:

• DAYTONA_API_KEY: Your Daytona API key
• DAYTONA_API_URL: The Daytona API URL
• DAYTONA_TARGET: Your target region environment (e.g. us, eu)

require 'daytona'

# Initialize with environment variables
daytona = Daytona::Daytona.new

# Initialize with configuration object
config = Daytona::Config.new(
  api_key: 'YOUR_API_KEY',
  api_url: 'YOUR_API_URL',
  target: 'us'
)

Create a sandbox

Create a sandbox to run your code securely in an isolated environment.

require 'daytona'

config = Daytona::Config.new(api_key: 'YOUR_API_KEY')
daytona = Daytona::Daytona.new(config)
sandbox = daytona.create

Examples and guides

Daytona provides examples and guides for common sandbox operations, best practices, and a wide range of topics, from basic usage to advanced topics, showcasing various types of integrations between Daytona and other tools.

Create a sandbox with custom resources

Create a sandbox with custom resources (CPU, memory, disk).

require 'daytona'

daytona = Daytona::Daytona.new
sandbox = daytona.create(
    Daytona::CreateSandboxFromImageParams.new(
        image: Daytona::Image.debian_slim('3.12'),
        resources: Daytona::Resources.new(cpu: 2, memory: 4, disk: 8)
    )
)

Create an ephemeral sandbox

Create an ephemeral sandbox that is automatically deleted when stopped.

require 'daytona'

daytona = Daytona::Daytona.new
sandbox = daytona.create(
    Daytona::CreateSandboxFromSnapshotParams.new(ephemeral: true, auto_stop_interval: 5)
)

Create a sandbox from a snapshot

Create a sandbox from a snapshot.

require 'daytona'

daytona = Daytona::Daytona.new
sandbox = daytona.create(
    Daytona::CreateSandboxFromSnapshotParams.new(
        snapshot: 'my-snapshot-name'
    )
)

Execute commands

Execute commands in the sandbox.

# Execute any shell command
response = sandbox.process.exec(command: 'ls -la')
puts response.result

# Setting a working directory and a timeout
response = sandbox.process.exec(command: 'sleep 3', cwd: 'workspace/src', timeout: 5)
puts response.result

# Passing environment variables
response = sandbox.process.exec(
  command: 'echo $CUSTOM_SECRET',
  env: { 'CUSTOM_SECRET' => 'DAYTONA' }
)
puts response.result

File operations

Upload, download, and search files in the sandbox.

# Upload a text file from string content
content = "Hello, World!"
sandbox.fs.upload_file(content, "tmp/hello.txt")

# Download and get file content
content = sandbox.fs.download_file("workspace/data/file.txt")
puts content

# Get file metadata
info = sandbox.fs.get_file_info("workspace/data/file.txt")
puts "Size: #{info.size} bytes"
puts "Modified: #{info.mod_time}"
puts "Mode: #{info.mode}"

Git operations

Clone, list branches, and add files to the sandbox.

# Basic clone
sandbox.git.clone(
  url: 'https://github.com/daytona/clients.git',
  path: 'workspace/repo'
)

# List branches
response = sandbox.git.branches('workspace/repo')
puts "Branches: #{response.branches}"

# Add files
sandbox.git.add('workspace/repo', ['README.md'])

Language server protocol

Create and start a language server to get code completions, document symbols, and more.

# Create a language server
lsp_server = sandbox.create_lsp_server(
  language_id: Daytona::LspServer::Language::PYTHON,
  path_to_project: 'workspace/project'
)
lsp_server.start

# Notify server that a file is open
lsp_server.did_open('workspace/project/main.py')

# Get document symbols
symbols = lsp_server.document_symbols('workspace/project/main.py')

# Get completions
completions = lsp_server.completions(
  path: 'workspace/project/main.py',
  position: Daytona::LspServer::Position.new(line: 10, character: 15)
)

List method return shapes

Each list method returns a different shape depending on the resource. The table below shows the exact return type and how to access the elements.

Method	Return type	Shape	Access elements
daytona.snapshot.list(page:, limit:)	Daytona::PaginatedResource	Paginated wrapper	result.items.each
daytona.secret.list(cursor:, limit:, ...)	Daytona::ListSecretsResponse	Cursor-paginated wrapper	page.items.each
daytona.volume.list	Array<Daytona::Volume>	Bare array	iterate directly
daytona.list(query)	Enumerator<Daytona::Sandbox>	Lazy enumerator	`.each { \	s\	... }`

PaginatedResource and ListSecretsResponse are wrapper objects, not arrays. Calling .each or .map directly on them raises NoMethodError. Always go through .items:

# snapshots — page-number pagination
result = daytona.snapshot.list(page: 1, limit: 20)
# result.items       => Array<Daytona::Snapshot>
# result.total       => Float (total across all pages)
# result.page        => Float (current page, 1-indexed)
# result.total_pages => Float
result.items.each { |snapshot| puts "#{snapshot.name} (#{snapshot.image_name})" }

# secrets — cursor pagination
cursor = nil
loop do
  page = daytona.secret.list(cursor: cursor, limit: 100)
  # page.items       => Array<Daytona::Secret>
  # page.total       => Float
  # page.next_cursor => String | nil (nil = no more pages)
  page.items.each { |secret| puts secret.name }
  cursor = page.next_cursor
  break if cursor.nil?
end

# volumes — bare array, iterate directly
daytona.volume.list.each { |vol| puts vol.name }

# sandboxes — lazy enumerator, fetches pages on demand
query = Daytona::ListSandboxesQuery.new(labels: { 'env' => 'dev' })
daytona.list(query).each { |sandbox| puts sandbox.id }