# Ona Documentation

## Docs

- [Ona Changelog](https://ona.com/docs/changelog.md): Product updates and announcements
- [Add your first secret](https://ona.com/docs/ona/add-first-secret.md): Store API keys and credentials so agents can connect to external services.
- [Teach agents your codebase](https://ona.com/docs/ona/agents-md.md): Help Ona Agent understand your project conventions, commands, and architecture with AGENTS.md.
- [Image attachments](https://ona.com/docs/ona/agents/image-attachments.md): Attach screenshots and images to your Ona Agent prompts for visual context.
- [Mermaid diagrams](https://ona.com/docs/ona/agents/mermaid-diagrams.md): Visualize architecture, dependencies, and workflows with agent-generated diagrams
- [Ona Agent](https://ona.com/docs/ona/agents/overview.md): Ona Agent completes engineering tasks autonomously in secure, isolated environments.
- [GitHub & GitLab tools](https://ona.com/docs/ona/agents/scm-tools.md): Built-in tools for managing pull requests, issues, and code reviews
- [Shareable links](https://ona.com/docs/ona/agents/shareable-links.md): Share pre-populated Ona prompts with your team via URL.
- [Skills](https://ona.com/docs/ona/agents/skills.md): Teach Ona Agent to follow your workflows automatically.
- [API Reference](https://ona.com/docs/ona/api-reference.md)
- [Audit logs](https://ona.com/docs/ona/audit-logs/overview.md)
- [Automations as Code](https://ona.com/docs/ona/automations/automations-as-code.md): Define, version, and share Automations using YAML files and the Ona CLI.
- [Automations in practice](https://ona.com/docs/ona/automations/automations-in-practice.md): Set up five real-world Automations: Sentry triage, autonomous backlog picker, Knip cleanup, CVE remediation, and migrations at scale.
- [Configure Automations](https://ona.com/docs/ona/automations/configure-automations.md): Configure triggers, steps, guardrails, and workflows
- [Automation guardrails](https://ona.com/docs/ona/automations/guardrails.md): Safety controls and policies for Automations
- [Background automations](https://ona.com/docs/ona/automations/overview.md): Proactive background agents that combine AI prompts with deterministic commands in trigger-based, closed-loop workflows.
- [Plans and limits](https://ona.com/docs/ona/automations/plans-and-limits.md): Automation limits by organization plan
- [Report step](https://ona.com/docs/ona/automations/report-step.md): Extract structured data from Automation executions
- [Running an Automation](https://ona.com/docs/ona/automations/running-automations.md): Execute and monitor Automations
- [Sharing Automations](https://ona.com/docs/ona/automations/sharing-automations.md): Share Automations with individual users, groups, or your entire organization
- [Manual triggers](https://ona.com/docs/ona/automations/triggers/manual.md): Run Automations on demand
- [Pull request triggers](https://ona.com/docs/ona/automations/triggers/pullrequest.md): Trigger Automations from pull request events
- [Time-based triggers](https://ona.com/docs/ona/automations/triggers/timebased.md): Schedule Automations on a recurring basis
- [Troubleshooting automations](https://ona.com/docs/ona/automations/troubleshooting.md): Common Automation issues and solutions
- [Webhooks](https://ona.com/docs/ona/automations/webhooks.md): Receive SCM events to trigger Automations
- [Bash commands](https://ona.com/docs/ona/bash-commands.md): Run bash commands in sessions using the ! prefix
- [Best practices](https://ona.com/docs/ona/best-practices.md): Best practices for using Ona environments, agents, and guardrails effectively in your development workflow.
- [Billing](https://ona.com/docs/ona/billing/overview.md): Manage billing for Free and Core Ona Cloud organizations.
- [Usage & credits](https://ona.com/docs/ona/billing/usage.md): Understand usage and OCU billing for Free and Core Ona Cloud organizations.
- [Command deny list](https://ona.com/docs/ona/command-deny-list.md): Block specific commands from being executed by Ona Agent.
- [Set up your first environment](https://ona.com/docs/ona/configuration/devcontainer/getting-started.md): Create a Dev Container so your environments and agents have everything they need.
- [Optimize startup times](https://ona.com/docs/ona/configuration/devcontainer/optimizing-startup-times.md): Fast startup times enable humans and agents to work effectively and autonomously across multiple tasks in parallel.
- [Container configuration](https://ona.com/docs/ona/configuration/devcontainer/overview.md): Standardize development environments across your team with Dev Container configuration.
- [Dotfiles](https://ona.com/docs/ona/configuration/dotfiles/overview.md): Bring your shell, editor, and tool configurations to every environment.
- [Migrate from Gitpod Classic to Ona](https://ona.com/docs/ona/configuration/migrate-from-classic.md): Convert your Gitpod Classic .gitpod.yml to Ona Dev Container and Tasks configuration.
- [Multi-repository environments](https://ona.com/docs/ona/configuration/multi-repository.md): Work with multiple repositories in a single environment for microservices and monorepo workflows.
- [OpenID Connect (OIDC)](https://ona.com/docs/ona/configuration/oidc.md): Guide to using OpenID Connect (OIDC) in Ona
- [Container registry](https://ona.com/docs/ona/configuration/secrets/container-registry-secret.md): Authenticate with private container registries for Dev Container images.
- [Environment variables](https://ona.com/docs/ona/configuration/secrets/environment-variables.md)
- [File secrets](https://ona.com/docs/ona/configuration/secrets/files.md)
- [How secrets work](https://ona.com/docs/ona/configuration/secrets/overview.md): Securely store API keys, tokens, and credentials for your environments and agents.
- [User secrets](https://ona.com/docs/ona/configuration/secrets/user-secrets.md): Personal secrets available across all your projects and environments.
- [Task & service examples](https://ona.com/docs/ona/configuration/tasks-and-services/examples.md): Common patterns for database setup, preview servers, cloud auth, and more.
- [Dynamic configuration](https://ona.com/docs/ona/configuration/tasks-and-services/generating-tasks-and-services.md): Generate tasks and services programmatically based on what agents discover in your codebase.
- [Startup tasks & services](https://ona.com/docs/ona/configuration/tasks-and-services/overview.md): Automate environment setup and define repeatable actions for humans and agents.
- [Create your first Automation](https://ona.com/docs/ona/create-first-automation.md): Go from zero to a scheduled Automation: set up a project, make your repository AI-ready, and run your first closed-loop workflow.
- [Create your first project](https://ona.com/docs/ona/create-first-project.md): Connect a repository to Ona so you can launch environments, configure Dev Containers, and run Automations against it.
- [Custom domain](https://ona.com/docs/ona/custom-domain.md): Set up a custom domain for your Ona management plane with TLS termination
- [Cursor](https://ona.com/docs/ona/editors/cursor.md): Connect to Ona environments using Cursor editor.
- [JetBrains](https://ona.com/docs/ona/editors/jetbrains.md): Integrate JetBrains IDEs with Ona
- [Supported editors](https://ona.com/docs/ona/editors/overview.md): IDEs & Editors supported by Ona
- [Visual Studio Code](https://ona.com/docs/ona/editors/vscode.md): Connect to Ona environments using Visual Studio Code with the Ona extension.
- [VS Code browser](https://ona.com/docs/ona/editors/vscode-browser.md): Connect to Ona environments using VS Code in the browser with zero installation.
- [Windsurf](https://ona.com/docs/ona/editors/windsurf.md): Connect to Ona environments using Windsurf editor.
- [Zed](https://ona.com/docs/ona/editors/zed.md): Connect to Ona environments using Zed editor via SSH.
- [Using environments from external agents](https://ona.com/docs/ona/environments/agent-environments.md): Manage Ona environments from external AI agents like Claude Code or Cursor using the Ona CLI.
- [Archive & auto-delete](https://ona.com/docs/ona/environments/archive-auto-delete.md): How Ona archives and deletes inactive environments.
- [Development environments](https://ona.com/docs/ona/environments/overview.md): Isolated development workspaces for humans and agents.
- [Persistent storage](https://ona.com/docs/ona/environments/persistent-storage.md): What persists in Ona environments across stops, starts, and Dev Container rebuilds.
- [Overview](https://ona.com/docs/ona/getting-started.md): The platform for background agents.
- [Veto - Datawall](https://ona.com/docs/ona/guardrails/datawall.md): Detect confidential data leaving Ona environments over the network using kernel-level fingerprinting.
- [Guardrails](https://ona.com/docs/ona/guardrails/overview.md): Understand the identity, policy, enforcement, and audit controls that govern Ona environments and agents.
- [Veto](https://ona.com/docs/ona/guardrails/veto.md): Kernel-level enforcement engine that protects AI agent environments from unauthorized execution and data exfiltration.
- [AWS](https://ona.com/docs/ona/integrations/aws.md): Access AWS resources from environments using OIDC.
- [Browser extension](https://ona.com/docs/ona/integrations/browser-extension.md): One-click environment creation from GitHub, GitLab, Bitbucket, and Azure DevOps.
- [CLI](https://ona.com/docs/ona/integrations/cli.md): Manage environments, SSH access, and automations from your terminal.
- [Atlassian](https://ona.com/docs/ona/integrations/configure-atlassian.md): Connect agents to Jira and Confluence so they can manage issues, search documentation, and stay in sync with your workflow.
- [Granola](https://ona.com/docs/ona/integrations/configure-granola.md): Connect agents to your Granola meeting notes so they can search transcripts, extract action items, and access meeting context.
- [Linear](https://ona.com/docs/ona/integrations/configure-linear.md): Connect agents to your project management so they can create issues, update status, and stay in sync with your workflow.
- [Notion](https://ona.com/docs/ona/integrations/configure-notion.md): Connect agents to your Notion workspace so they can search pages, read documentation, and access project context.
- [Sentry](https://ona.com/docs/ona/integrations/configure-sentry.md): Connect agents to Sentry so they can view errors, analyze stack traces, and access monitoring context.
- [Integrations](https://ona.com/docs/ona/integrations/overview.md): Connect Ona to source control, work trackers, docs, incident tools, and cloud providers.
- [Personal access tokens](https://ona.com/docs/ona/integrations/personal-access-token.md): Authenticate CLI and SDK access for automation and CI/CD.
- [Port sharing](https://ona.com/docs/ona/integrations/ports.md): Expose ports from environments to share running services.
- [Ona SDK](https://ona.com/docs/ona/integrations/sdk.md)
- [MCP servers](https://ona.com/docs/ona/mcp.md): Extend Ona Agent with external tools using the Model Context Protocol
- [Announcement banner](https://ona.com/docs/ona/organizations/announcement-banner.md)
- [Create or join an organization](https://ona.com/docs/ona/organizations/create-organization.md)
- [Manage groups](https://ona.com/docs/ona/organizations/groups.md)
- [Insights](https://ona.com/docs/ona/organizations/insights.md)
- [Manage members](https://ona.com/docs/ona/organizations/manage-members.md)
- [Manage organization](https://ona.com/docs/ona/organizations/manage-organization.md)
- [Organization roles](https://ona.com/docs/ona/organizations/organization-roles.md)
- [Organization secrets](https://ona.com/docs/ona/organizations/organization-secrets.md)
- [Team management](https://ona.com/docs/ona/organizations/overview.md): Organizations let teams share runners, projects, and secrets with role-based access control.
- [Maximum environment lifetime](https://ona.com/docs/ona/organizations/policies/environment-lifetime.md): Set a maximum age for environments and optionally block restarting expired ones.
- [Environment timeout](https://ona.com/docs/ona/organizations/policies/environment-timeout.md): Limit auto-stop timeout options to control resource usage and costs.
- [Veto - Executable Deny List](https://ona.com/docs/ona/organizations/policies/executable-deny-list.md): Block specific executables from running in organization environments using kernel-level enforcement.
- [Organization policies](https://ona.com/docs/ona/organizations/policies/overview.md): Control resource usage, enforce consistency, and implement security restrictions across your organization.
- [Security agents](https://ona.com/docs/ona/organizations/policies/security-agents.md): Deploy security agents like CrowdStrike Falcon to all organization environments.
- [Service accounts](https://ona.com/docs/ona/organizations/service-accounts.md)
- [Sharing resources](https://ona.com/docs/ona/organizations/sharing-resources.md)
- [Project configuration](https://ona.com/docs/ona/projects/overview.md)
- [Prebuilds](https://ona.com/docs/ona/projects/prebuilds.md)
- [Managing prebuilds](https://ona.com/docs/ona/projects/prebuilds-management.md)
- [Setup prebuilds](https://ona.com/docs/ona/projects/prebuilds-setup.md)
- [Project secrets](https://ona.com/docs/ona/projects/project-secrets.md)
- [Project visibility](https://ona.com/docs/ona/projects/project-sharing.md)
- [Warm Pools](https://ona.com/docs/ona/projects/warm-pools.md)
- [Quickstart](https://ona.com/docs/ona/quickstart.md): Get up and running with Ona in less than 5 minutes.
- [automations.yaml schema](https://ona.com/docs/ona/reference/automations-yaml-schema.md): Field reference for tasks and services in automations.yaml.
- [CLI command reference](https://ona.com/docs/ona/reference/cli.md): Common Ona CLI commands for environments, automations, and configuration.
- [Regions and latency](https://ona.com/docs/ona/runners/aws/aws-regions.md)
- [Costs & budgeting](https://ona.com/docs/ona/runners/aws/aws-runner-costs.md)
- [Capacity planning](https://ona.com/docs/ona/runners/aws/capacity-planning.md)
- [Configuring repository access](https://ona.com/docs/ona/runners/aws/configuring-repository-access.md)
- [AWS access requirements](https://ona.com/docs/ona/runners/aws/detailed-access-requirements.md)
- [Dev container image cache](https://ona.com/docs/ona/runners/aws/devcontainer-image-cache.md): Cache built Dev Container images to reduce environment startup times.
- [Environment classes](https://ona.com/docs/ona/runners/aws/environment-classes.md)
- [AWS runners](https://ona.com/docs/ona/runners/aws/overview.md)
- [Setup AWS runner](https://ona.com/docs/ona/runners/aws/setup.md)
- [Troubleshooting AWS runners](https://ona.com/docs/ona/runners/aws/troubleshooting-runners.md): Troubleshoot AWS runner issues.
- [Zscaler troubleshooting](https://ona.com/docs/ona/runners/aws/troubleshooting-zscaler.md): Troubleshoot Zscaler compatibility issues with Ona
- [Upgrade runner](https://ona.com/docs/ona/runners/aws/update-runner.md): Upgrade your AWS runner infrastructure to the latest CloudFormation template.
- [VPC Endpoints](https://ona.com/docs/ona/runners/aws/vpc-endpoints.md)
- [Alerts and Dashboards](https://ona.com/docs/ona/runners/gcp/alerts-and-dashboards.md)
- [GCP access requirements](https://ona.com/docs/ona/runners/gcp/detailed-access-requirements.md)
- [Costs & Budgeting for GCP Runner](https://ona.com/docs/ona/runners/gcp/gcp-runner-costs.md)
- [GCP runners](https://ona.com/docs/ona/runners/gcp/overview.md)
- [Using private Google Artifact Registry images](https://ona.com/docs/ona/runners/gcp/private-gar-images.md)
- [Setup GCP runner](https://ona.com/docs/ona/runners/gcp/setup.md)
- [Troubleshooting GCP runners](https://ona.com/docs/ona/runners/gcp/troubleshooting-runners.md): Learn how to troubleshoot GCP runners.
- [Updating a Runner](https://ona.com/docs/ona/runners/gcp/update-runner.md): Learn how to update your GCP runner.
- [Private Vertex AI connectivity](https://ona.com/docs/ona/runners/gcp/vertex-ai-private-connectivity.md)
- [Monitoring and Metrics](https://ona.com/docs/ona/runners/monitoring-and-metrics.md)
- [Ona Cloud](https://ona.com/docs/ona/runners/ona-cloud.md)
- [Runner infrastructure](https://ona.com/docs/ona/runners/overview.md): Runners provision and manage your environments and agents. Deploy on Ona Cloud or in your own AWS or GCP account.
- [SCIM Provisioning](https://ona.com/docs/ona/scim/overview.md)
- [Organization-level skills](https://ona.com/docs/ona/skills.md): Codify your organization's best practices into reusable skills that agents can discover and anyone can run.
- [Azure DevOps](https://ona.com/docs/ona/source-control/azuredevops.md): Configure Azure DevOps as a source control provider for your Ona environments.
- [Bitbucket Cloud](https://ona.com/docs/ona/source-control/bitbucket.md): Configure Bitbucket Cloud as a source control provider for your Ona environments.
- [GitHub](https://ona.com/docs/ona/source-control/github.md): Configure GitHub as a source control provider for your Ona environments.
- [GitLab](https://ona.com/docs/ona/source-control/gitlab.md): Configure GitLab as a source control provider for your Ona environments.
- [Git providers](https://ona.com/docs/ona/source-control/overview.md): Source control integrations in Ona
- [Amazon Cognito](https://ona.com/docs/ona/sso/cognito.md)
- [Microsoft Entra ID](https://ona.com/docs/ona/sso/entra.md)
- [GitLab SSO](https://ona.com/docs/ona/sso/gitlab.md)
- [Google](https://ona.com/docs/ona/sso/google.md)
- [Okta](https://ona.com/docs/ona/sso/okta.md)
- [Single sign-on (SSO)](https://ona.com/docs/ona/sso/overview.md): Overview of SSO options for Ona
- [PingFederate](https://ona.com/docs/ona/sso/pingfederate.md)
- [Troubleshooting guide](https://ona.com/docs/ona/troubleshooting.md): Diagnose issues with environments, runners, and IDEs using support bundles and logs.
- [Architecture Overview](https://ona.com/docs/ona/understanding/architecture.md): How the management plane and runners work together to keep your code secure while providing a consistent development experience.
- [Core Components](https://ona.com/docs/ona/understanding/core-components.md): The five building blocks of Ona and how they work together.
- [How Ona Works](https://ona.com/docs/ona/understanding/how-ona-works.md): Understand how Ona combines environments, agents, and runners to deliver a complete development platform.
- [Workflows](https://ona.com/docs/ona/workflows.md): End-to-end recipes for common tasks with Ona Agent.
- [Runner Updates](https://ona.com/docs/runner-updates.md): Runner version releases and infrastructure updates

## OpenAPI Specs

- [openapi](https://ona.com/docs/api-reference/openapi.json)