mirror of
https://github.com/hanzoai/runtime.git
synced 2026-10-30 18:23:13 +00:00
zeekay
0c7efccf40
- Add main Dockerfile for production builds - Add Dockerfile.runtime for secure code execution - Add Dockerfile.runtime.fixed with improved configuration - Include .dockerignore for build optimization - Add integration documentation and publishing guides - Update API and CLI components for better runtime support - Enhance sandbox and container management features
175 lines
13 KiB
Plaintext
175 lines
13 KiB
Plaintext
# Runtime Documentation v0.0.0-dev
|
|
# Generated on: 2025-07-15
|
|
|
|
# Runtime
|
|
|
|
> Secure and Elastic Infrastructure for Running Your Al-Generated Code.
|
|
|
|
## Docs
|
|
|
|
- [API Keys](https://hanzo.ai/docs/api-keys)
|
|
- [Expiration](https://hanzo.ai/docs/api-keys#expiration)
|
|
- [Permissions](https://hanzo.ai/docs/api-keys#permissions)
|
|
- [Billing](https://hanzo.ai/docs/billing)
|
|
- [Wallet](https://hanzo.ai/docs/billing#wallet)
|
|
- [Automatic Top-Up](https://hanzo.ai/docs/billing#automatic-top-up)
|
|
- [Cost Breakdown](https://hanzo.ai/docs/billing#cost-breakdown)
|
|
- [Configuration](https://hanzo.ai/docs/configuration)
|
|
- [Set Up Your Environment Variables](https://hanzo.ai/docs/configuration#set-up-your-environment-variables)
|
|
- [Configuration Options](https://hanzo.ai/docs/configuration#configuration-options)
|
|
- [Environment Variables](https://hanzo.ai/docs/configuration#environment-variables)
|
|
- [Setting Environment Variables](https://hanzo.ai/docs/configuration#setting-environment-variables)
|
|
- [Configuration Precedence](https://hanzo.ai/docs/configuration#configuration-precedence)
|
|
- [Declarative Builder](https://hanzo.ai/docs/declarative-builder)
|
|
- [Overview](https://hanzo.ai/docs/declarative-builder#overview)
|
|
- [Base Image Selection](https://hanzo.ai/docs/declarative-builder#base-image-selection)
|
|
- [Package Management](https://hanzo.ai/docs/declarative-builder#package-management)
|
|
- [File System Operations](https://hanzo.ai/docs/declarative-builder#file-system-operations)
|
|
- [Environment Configuration](https://hanzo.ai/docs/declarative-builder#environment-configuration)
|
|
- [Dynamic Image Building](https://hanzo.ai/docs/declarative-builder#dynamic-image-building)
|
|
- [Creating Pre-built Snapshots](https://hanzo.ai/docs/declarative-builder#creating-pre-built-snapshots)
|
|
- [Using an Existing Dockerfile](https://hanzo.ai/docs/declarative-builder#using-an-existing-dockerfile)
|
|
- [Best Practices](https://hanzo.ai/docs/declarative-builder#best-practices)
|
|
- [File System Operations](https://hanzo.ai/docs/file-system-operations)
|
|
- [Basic Operations](https://hanzo.ai/docs/file-system-operations#basic-operations)
|
|
- [Listing Files and Directories](https://hanzo.ai/docs/file-system-operations#listing-files-and-directories)
|
|
- [Creating Directories](https://hanzo.ai/docs/file-system-operations#creating-directories)
|
|
- [Uploading Files](https://hanzo.ai/docs/file-system-operations#uploading-files)
|
|
- [Downloading Files](https://hanzo.ai/docs/file-system-operations#downloading-files)
|
|
- [Deleting files](https://hanzo.ai/docs/file-system-operations#deleting-files)
|
|
- [Advanced Operations](https://hanzo.ai/docs/file-system-operations#advanced-operations)
|
|
- [File Permissions](https://hanzo.ai/docs/file-system-operations#file-permissions)
|
|
- [File Search and Replace](https://hanzo.ai/docs/file-system-operations#file-search-and-replace)
|
|
- [Getting Started](https://hanzo.ai/docs/getting-started)
|
|
- [Install the Runtime SDK](https://hanzo.ai/docs/getting-started#install-the-runtime-sdk)
|
|
- [Run Code Inside a Sandbox](https://hanzo.ai/docs/getting-started#run-code-inside-a-sandbox)
|
|
- [Preview Your App](https://hanzo.ai/docs/getting-started#preview-your-app)
|
|
- [Connect to an LLM](https://hanzo.ai/docs/getting-started#connect-to-an-llm)
|
|
- [Additional Examples](https://hanzo.ai/docs/getting-started#additional-examples)
|
|
- [Setting up the Runtime CLI](https://hanzo.ai/docs/getting-started#setting-up-the-runtime-cli)
|
|
- [Git Operations](https://hanzo.ai/docs/git-operations)
|
|
- [Basic Operations](https://hanzo.ai/docs/git-operations#basic-operations)
|
|
- [Cloning Repositories](https://hanzo.ai/docs/git-operations#cloning-repositories)
|
|
- [Repository Status](https://hanzo.ai/docs/git-operations#repository-status)
|
|
- [Branch Operations](https://hanzo.ai/docs/git-operations#branch-operations)
|
|
- [Managing Branches](https://hanzo.ai/docs/git-operations#managing-branches)
|
|
- [Staging and Committing](https://hanzo.ai/docs/git-operations#staging-and-committing)
|
|
- [Working with Changes](https://hanzo.ai/docs/git-operations#working-with-changes)
|
|
- [Remote Operations](https://hanzo.ai/docs/git-operations#remote-operations)
|
|
- [Working with Remotes](https://hanzo.ai/docs/git-operations#working-with-remotes)
|
|
- [Runtime Documentation](https://hanzo.ai/docs/index)
|
|
- [Quick Start](https://hanzo.ai/docs/index#quick-start)
|
|
- [Language Server Protocol](https://hanzo.ai/docs/language-server-protocol)
|
|
- [Creating LSP Servers](https://hanzo.ai/docs/language-server-protocol#creating-lsp-servers)
|
|
- [Supported Languages](https://hanzo.ai/docs/language-server-protocol#supported-languages)
|
|
- [LSP Features](https://hanzo.ai/docs/language-server-protocol#lsp-features)
|
|
- [Code Completion](https://hanzo.ai/docs/language-server-protocol#code-completion)
|
|
- [Limits](https://hanzo.ai/docs/limits)
|
|
- [Manage usage dynamically](https://hanzo.ai/docs/limits#manage-usage-dynamically)
|
|
- [Tiers & Limit Increases](https://hanzo.ai/docs/limits#tiers--limit-increases)
|
|
- [Need More?](https://hanzo.ai/docs/limits#need-more)
|
|
- [Linked Accounts](https://hanzo.ai/docs/linked-accounts)
|
|
- [How to link an account](https://hanzo.ai/docs/linked-accounts#how-to-link-an-account)
|
|
- [How to unlink an account](https://hanzo.ai/docs/linked-accounts#how-to-unlink-an-account)
|
|
- [Need More?](https://hanzo.ai/docs/linked-accounts#need-more)
|
|
- [Log Streaming](https://hanzo.ai/docs/log-streaming)
|
|
- [Asynchronous](https://hanzo.ai/docs/log-streaming#asynchronous)
|
|
- [Synchronous](https://hanzo.ai/docs/log-streaming#synchronous)
|
|
- [Runtime MCP Server](https://hanzo.ai/docs/mcp)
|
|
- [Prerequisites](https://hanzo.ai/docs/mcp#prerequisites)
|
|
- [Installation and Setup](https://hanzo.ai/docs/mcp#installation-and-setup)
|
|
- [1. Install Runtime CLI](https://hanzo.ai/docs/mcp#1-install-runtime-cli)
|
|
- [2. Authenticate with Runtime](https://hanzo.ai/docs/mcp#2-authenticate-with-runtime)
|
|
- [3. Initialize MCP Server](https://hanzo.ai/docs/mcp#3-initialize-mcp-server)
|
|
- [4. Open Your AI Agent](https://hanzo.ai/docs/mcp#4-open-your-ai-agent)
|
|
- [Integration with Other AI Agents](https://hanzo.ai/docs/mcp#integration-with-other-ai-agents)
|
|
- [Available Tools](https://hanzo.ai/docs/mcp#available-tools)
|
|
- [Sandbox Management](https://hanzo.ai/docs/mcp#sandbox-management)
|
|
- [File Operations](https://hanzo.ai/docs/mcp#file-operations)
|
|
- [Preview](https://hanzo.ai/docs/mcp#preview)
|
|
- [Git Operations](https://hanzo.ai/docs/mcp#git-operations)
|
|
- [Command Execution](https://hanzo.ai/docs/mcp#command-execution)
|
|
- [Troubleshooting](https://hanzo.ai/docs/mcp#troubleshooting)
|
|
- [Support](https://hanzo.ai/docs/mcp#support)
|
|
- [Organizations](https://hanzo.ai/docs/organizations)
|
|
- [Organization Roles](https://hanzo.ai/docs/organizations#organization-roles)
|
|
- [Administrative Actions](https://hanzo.ai/docs/organizations#administrative-actions)
|
|
- [Inviting New Users](https://hanzo.ai/docs/organizations#inviting-new-users)
|
|
- [Available Assignments](https://hanzo.ai/docs/organizations#available-assignments)
|
|
- [Managing Invitations](https://hanzo.ai/docs/organizations#managing-invitations)
|
|
- [Settings](https://hanzo.ai/docs/organizations#settings)
|
|
- [Preview & Authentication](https://hanzo.ai/docs/preview-and-authentication)
|
|
- [Process and Code Execution](https://hanzo.ai/docs/process-code-execution)
|
|
- [Code Execution](https://hanzo.ai/docs/process-code-execution#code-execution)
|
|
- [Running Code](https://hanzo.ai/docs/process-code-execution#running-code)
|
|
- [Process Execution](https://hanzo.ai/docs/process-code-execution#process-execution)
|
|
- [Running Commands](https://hanzo.ai/docs/process-code-execution#running-commands)
|
|
- [Sessions (Background Processes)](https://hanzo.ai/docs/process-code-execution#sessions-background-processes)
|
|
- [Managing Long-Running Processes](https://hanzo.ai/docs/process-code-execution#managing-long-running-processes)
|
|
- [Best Practices](https://hanzo.ai/docs/process-code-execution#best-practices)
|
|
- [Common Issues](https://hanzo.ai/docs/process-code-execution#common-issues)
|
|
- [Process Execution Failed](https://hanzo.ai/docs/process-code-execution#process-execution-failed)
|
|
- [Process Timeout](https://hanzo.ai/docs/process-code-execution#process-timeout)
|
|
- [Resource Limits](https://hanzo.ai/docs/process-code-execution#resource-limits)
|
|
- [Region Selection](https://hanzo.ai/docs/regions)
|
|
- [Sandbox Management](https://hanzo.ai/docs/sandbox-management)
|
|
- [Sandbox Lifecycle](https://hanzo.ai/docs/sandbox-management#sandbox-lifecycle)
|
|
- [Creating Sandboxes](https://hanzo.ai/docs/sandbox-management#creating-sandboxes)
|
|
- [Basic Sandbox Creation](https://hanzo.ai/docs/sandbox-management#basic-sandbox-creation)
|
|
- [Sandbox Resources](https://hanzo.ai/docs/sandbox-management#sandbox-resources)
|
|
- [Sandbox Information](https://hanzo.ai/docs/sandbox-management#sandbox-information)
|
|
- [Stop and Start Sandbox](https://hanzo.ai/docs/sandbox-management#stop-and-start-sandbox)
|
|
- [Archive Sandbox](https://hanzo.ai/docs/sandbox-management#archive-sandbox)
|
|
- [Delete Sandbox](https://hanzo.ai/docs/sandbox-management#delete-sandbox)
|
|
- [Automated Lifecycle Management](https://hanzo.ai/docs/sandbox-management#automated-lifecycle-management)
|
|
- [Auto-stop Interval](https://hanzo.ai/docs/sandbox-management#auto-stop-interval)
|
|
- [Auto-archive Interval](https://hanzo.ai/docs/sandbox-management#auto-archive-interval)
|
|
- [Auto-delete Interval](https://hanzo.ai/docs/sandbox-management#auto-delete-interval)
|
|
- [Run Indefinitely](https://hanzo.ai/docs/sandbox-management#run-indefinitely)
|
|
- [Snapshots](https://hanzo.ai/docs/snapshots)
|
|
- [Creating Snapshots](https://hanzo.ai/docs/snapshots#creating-snapshots)
|
|
- [Snapshot Resources](https://hanzo.ai/docs/snapshots#snapshot-resources)
|
|
- [Images from Private Registries](https://hanzo.ai/docs/snapshots#images-from-private-registries)
|
|
- [Using a Local Image](https://hanzo.ai/docs/snapshots#using-a-local-image)
|
|
- [Deleting Snapshots](https://hanzo.ai/docs/snapshots#deleting-snapshots)
|
|
- [Default Snapshot](https://hanzo.ai/docs/snapshots#default-snapshot)
|
|
- [CLI](https://hanzo.ai/docs/tools/cli)
|
|
- [runtime](https://hanzo.ai/docs/tools/cli#runtime)
|
|
- [runtime autocomplete](https://hanzo.ai/docs/tools/cli#runtime-autocomplete)
|
|
- [runtime docs](https://hanzo.ai/docs/tools/cli#runtime-docs)
|
|
- [runtime login](https://hanzo.ai/docs/tools/cli#runtime-login)
|
|
- [runtime logout](https://hanzo.ai/docs/tools/cli#runtime-logout)
|
|
- [runtime mcp](https://hanzo.ai/docs/tools/cli#runtime-mcp)
|
|
- [runtime mcp config](https://hanzo.ai/docs/tools/cli#runtime-mcp-config)
|
|
- [runtime mcp init](https://hanzo.ai/docs/tools/cli#runtime-mcp-init)
|
|
- [runtime mcp start](https://hanzo.ai/docs/tools/cli#runtime-mcp-start)
|
|
- [runtime organization](https://hanzo.ai/docs/tools/cli#runtime-organization)
|
|
- [runtime organization create](https://hanzo.ai/docs/tools/cli#runtime-organization-create)
|
|
- [runtime organization delete](https://hanzo.ai/docs/tools/cli#runtime-organization-delete)
|
|
- [runtime organization list](https://hanzo.ai/docs/tools/cli#runtime-organization-list)
|
|
- [runtime organization use](https://hanzo.ai/docs/tools/cli#runtime-organization-use)
|
|
- [runtime sandbox](https://hanzo.ai/docs/tools/cli#runtime-sandbox)
|
|
- [runtime sandbox create](https://hanzo.ai/docs/tools/cli#runtime-sandbox-create)
|
|
- [runtime sandbox delete](https://hanzo.ai/docs/tools/cli#runtime-sandbox-delete)
|
|
- [runtime sandbox info](https://hanzo.ai/docs/tools/cli#runtime-sandbox-info)
|
|
- [runtime sandbox list](https://hanzo.ai/docs/tools/cli#runtime-sandbox-list)
|
|
- [runtime sandbox start](https://hanzo.ai/docs/tools/cli#runtime-sandbox-start)
|
|
- [runtime sandbox stop](https://hanzo.ai/docs/tools/cli#runtime-sandbox-stop)
|
|
- [runtime snapshot](https://hanzo.ai/docs/tools/cli#runtime-snapshot)
|
|
- [runtime snapshot create](https://hanzo.ai/docs/tools/cli#runtime-snapshot-create)
|
|
- [runtime snapshot delete](https://hanzo.ai/docs/tools/cli#runtime-snapshot-delete)
|
|
- [runtime snapshot list](https://hanzo.ai/docs/tools/cli#runtime-snapshot-list)
|
|
- [runtime snapshot push](https://hanzo.ai/docs/tools/cli#runtime-snapshot-push)
|
|
- [runtime version](https://hanzo.ai/docs/tools/cli#runtime-version)
|
|
- [runtime volume](https://hanzo.ai/docs/tools/cli#runtime-volume)
|
|
- [runtime volume create](https://hanzo.ai/docs/tools/cli#runtime-volume-create)
|
|
- [runtime volume delete](https://hanzo.ai/docs/tools/cli#runtime-volume-delete)
|
|
- [runtime volume get](https://hanzo.ai/docs/tools/cli#runtime-volume-get)
|
|
- [runtime volume list](https://hanzo.ai/docs/tools/cli#runtime-volume-list)
|
|
- [Volumes](https://hanzo.ai/docs/volumes)
|
|
- [Creating Volumes](https://hanzo.ai/docs/volumes#creating-volumes)
|
|
- [Mounting Volumes to Sandboxes](https://hanzo.ai/docs/volumes#mounting-volumes-to-sandboxes)
|
|
- [Deleting Volumes](https://hanzo.ai/docs/volumes#deleting-volumes)
|
|
- [Working with Volumes](https://hanzo.ai/docs/volumes#working-with-volumes)
|
|
- [Limitations](https://hanzo.ai/docs/volumes#limitations)
|
|
- [Web Terminal](https://hanzo.ai/docs/web-terminal) |