> ## Documentation Index
> Fetch the complete documentation index at: https://ona.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get up and running with Ona in less than 5 minutes.

> [!NOTE]
>
> New customer signup is closed. Existing customers and new members joining existing organizations can continue using Ona. Thank you for your interest; [get started with Codex](https://openai.com/codex/).

![Ona automations overview showing recent runs, filters, and suggested automation templates](https://mintcdn.com/gitpod-13c83c2b/rQ0qxOXkSmnLJSPc/images/docs/ona/quickstart/hero.png?fit=max\&auto=format\&n=rQ0qxOXkSmnLJSPc\&q=85\&s=7b0e09c347bd4a230f394e2c5a59450a)

By the end of this guide you'll have an environment running your code and an agent working on your first task.

[Sign in →](https://app.ona.com)

> [!NOTE]
>
> Existing Enterprise customers can continue using their deployments on [AWS](https://ona.com/docs/ona/runners/aws/overview.md) or [GCP](https://ona.com/docs/ona/runners/gcp/overview.md).

## Prerequisites

* An [Ona account](https://app.ona.com)
* Select your [Git provider](https://ona.com/docs/ona/source-control/overview.md)

## 1. Create a project

![Ona projects page showing a grid of projects and a New project button](https://mintcdn.com/gitpod-13c83c2b/rQ0qxOXkSmnLJSPc/images/docs/ona/quickstart/projects.png?fit=max\&auto=format\&n=rQ0qxOXkSmnLJSPc\&q=85\&s=0f32326c13d450a35b5605dd82e58043)

A project connects a repository to Ona, giving you a single place to manage environments, Automations, secrets, and team access for that codebase. Once a project exists, anyone on your team can spin up a fully configured environment in seconds. No local setup, no "works on my machine" problems.

Go to **Projects > New Project**, select your Git provider, and pick a repository. See [Create your first project](https://ona.com/docs/ona/create-first-project.md) for a detailed walkthrough.

> [!TIP]
>
> Speed up environment starts with [prebuilds](https://ona.com/docs/ona/projects/prebuilds.md) and [warm pools](https://ona.com/docs/ona/projects/warm-pools.md) so environments are ready before anyone needs them.

## 2. Start an environment

![Ona environment view showing a running environment with the conversation pane and environment details](https://mintcdn.com/gitpod-13c83c2b/rQ0qxOXkSmnLJSPc/images/docs/ona/quickstart/environment.png?fit=max\&auto=format\&n=rQ0qxOXkSmnLJSPc\&q=85\&s=fd049eac6614c802b48f0a31eabacfb0)

From your project, click **Create Environment**. Ona clones the repository into a container and provisions a development environment. Once the environment is running, you can open VS Code in your browser, talk to Ona, or [connect your preferred IDE](https://ona.com/docs/ona/editors/overview.md).

> [!TIP]
>
> If the environment stays in a loading state for more than two minutes, check that your repository is accessible and that your Git provider is connected under **Settings > Git Authentications**. See [troubleshooting](https://ona.com/docs/ona/troubleshooting.md) for more.

## 3. Talk to Ona

Once your environment is running, you have a session with Ona. Describe what you want to build, fix, or explore:

Paste one of these prompts into Ona:

Explore a codebase"Explain the architecture of this codebase"Paste into Ona

Fix failing tests"Fix the failing tests in the auth module"Paste into Ona

Add a feature"Add a new API endpoint for user preferences, following the patterns in the existing code"Paste into Ona

Review pull requests"Review the open pull requests and leave detailed code review comments"Paste into Ona

If you've connected [Linear](https://ona.com/docs/ona/integrations/configure-linear.md) or [Jira](https://ona.com/docs/ona/integrations/configure-atlassian.md), you can ask Ona to pick up tickets directly:

Pick up a Linear ticket"Pick up the next ticket assigned to me in Linear and start working on it"Paste into Ona

Implement a Jira ticket"Look at PROJ-142 in Jira and implement what's described"Paste into Ona

## 4. Optimize your environment

Ona works out of the box with a default image, but you'll get better results with a configured environment. You can set this up manually or let Ona do it. It will analyze your repository and generate a `devcontainer.json` and `.ona/config.yaml` tailored to your codebase.

Open Ona, then paste the prompt below if you want Ona to generate a starter configuration for the current environment.

[Open Ona →](https://app.ona.com)

> [accordion] View the full prompt
>
> ```text theme={null}
> Create a high-quality, fully working "development environment as code" configuration for the current environment.
>
> The setup must work for:
>   - Ona development environments, which use DevContainer configurations.
>   - All Git repositories mounted under the DevContainer workspace.
>
> Required Process
>   1. Read the documentation to fully understand:
>     - Ona tasks and services, secrets, environment variables, CLI, and prebuilds.
>     - DevContainer fundamentals and how they integrate with Ona and VS Code.
>   2. Analyze the source code and identify:
>     - Documentation on dev setup or contribution guidelines.
>     - Configuration files for containers, IDEs, build tools, environment variables, etc.
>   3. Update all necessary files, including:
>     - devcontainer.json
>     - Ona tasks and services
>   4. Run the Acceptance Tests and iterate until they pass.
>
> Success Criteria
>   - The DevContainer includes all tools needed to work with any file in any repo.
>   - Ona services exist for every service required to run any app.
>   - Ona tasks exist for all standard development workflows.
>   - If an app exposes a TCP port, the DevContainer must forward it.
>   - The DevContainer installs all VS Code extensions necessary to work effectively.
>
> Allowed Sources
>   - Ona documentation: https://ona.com/docs/llms.txt
>   - DevContainer documentation: https://containers.dev/
>   - DevContainers in VS Code: https://code.visualstudio.com/docs/devcontainers/containers
>   - DevContainer base images: https://hub.docker.com/r/microsoft/devcontainers
>   - Any publicly available DevContainer features
> ```

See [configure your environment](https://ona.com/docs/ona/configuration/devcontainer/getting-started.md) for a full reference on manual configuration.

## 5. Run agents in the background

![Ona automation editor showing the 10x engineer workflow configuration](https://mintcdn.com/gitpod-13c83c2b/rQ0qxOXkSmnLJSPc/images/docs/ona/quickstart/automations.png?fit=max\&auto=format\&n=rQ0qxOXkSmnLJSPc\&q=85\&s=83398db2d13ec9a22c05cae406001ce3)

Start multiple tasks from the home page using **Cmd+Enter** (Ctrl+Enter on Windows/Linux). Each task gets its own environment, so agents work in parallel without file conflicts.

When you're ready to automate that on a schedule, set up [Automations](https://ona.com/docs/ona/create-first-automation.md) to run agents on triggers like new issues or pull requests:

[10x engineerDaily, picks your top Linear issue, implements it, runs tests, and opens a draft PR.Use template →](https://ona.com/templates/10x-engineer)

[Scan recent commits for bugsScans recent commits for likely bugs and proposes minimal fixes in a draft PR.Use template →](https://ona.com/templates/scan-recent-commits-for-bugs)

[Sentry error triage and fixFinds the top unresolved Sentry error, traces it to source, applies a fix, and opens a PR.Use template →](https://ona.com/templates/sentry-error-triage-and-fix)

[Draft weekly release notesDrafts release notes from the week's merged PRs, grouped by category with summaries.Use template →](https://ona.com/templates/draft-weekly-release-notes)

[CVE mitigation and dependency updatesScans for CVEs or outdated dependencies, updates them, runs tests, and opens a PR with the fix.Use template →](https://ona.com/templates/cve-mitigation-dependency-updates)

[Daily standup generatorPulls Linear sprint data and git activity to post a formatted daily standup update.Use template →](https://ona.com/templates/daily-standup-generator)

## Tips

* **Be specific.** Describe the exact symptom and location rather than saying "fix the bug." See [be explicit](https://ona.com/docs/ona/best-practices.md#be-explicit).
* **Plan first.** For complex tasks, ask Ona to plan before implementing. See [plan before building](https://ona.com/docs/ona/best-practices.md#plan-before-building).
* **Commit often.** Ask Ona to commit working changes as checkpoints. See [commit early, commit often](https://ona.com/docs/ona/best-practices.md#commit-early-commit-often).

## Next steps

* [Best practices](https://ona.com/docs/ona/best-practices.md) for writing effective prompts and working with agents
* [Configure your environment](https://ona.com/docs/ona/configuration/devcontainer/getting-started.md) with Dev Containers, tasks, and services
* [Connect integrations](https://ona.com/docs/ona/integrations/overview.md) like Linear, Jira, Slack, and Sentry
* [Set up automations](https://ona.com/docs/ona/automations/configure-automations.md) to run agents on schedules and triggers
* [Teach agents your codebase](https://ona.com/docs/ona/agents-md.md) with AGENTS.md


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.