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

# Quickstart

> Deploy your first analytics agent in 1 minute

## Step 1: Install nao-core package

```bash theme={null}
pip install nao-core
```

<Tip>
  **Drive setup from your agentic CLI.** If you use Claude Code, Codex, Cursor, or any other agent that loads `SKILL.md` files, you can install the published nao skills and have the agent walk you through Steps 2–6 interactively:

  ```bash theme={null}
  nao skills add getnao/nao
  ```

  Then ask the agent to "use the setup-context skill". See [Skills](/nao-agent/context-engineering/skills) for what each one does and when to use it.
</Tip>

## Step 2: Initialize a nao project

```bash theme={null}
nao init
```

This command will ask you:

* To name your project
* If you want to connect a database *(optional)*
* If you want to add a repo in agent context *(optional)*
* To add an LLM key *(optional)*
* If you want to setup a Slack connection *(optional)*

<Info>
  You can skip any optional question and configure them later in your `nao_config.yaml` file.
</Info>

### Non-interactive mode

For CI pipelines or agentic workflows (Claude Code, Cursor, Codex), run `nao init` without any prompts:

```bash theme={null}
nao init --yes
```

| Flag                        | Description                       |
| --------------------------- | --------------------------------- |
| `--yes` / `-y` / `--no-tty` | Skip all prompts and use defaults |
| `--name` / `-n`             | Set the project name from the CLI |

In `--yes` mode:

* If `nao_config.yaml` already exists, it is reused as-is and only the folder structure is scaffolded.
* If no config exists, a minimal one is created with the project name (from `--name` or the current directory name).
* Databases, LLM, and integrations are not configured. Edit `nao_config.yaml` afterward or use the `setup-context` skill.

This will create:

* A new folder with your project name
* An architecture for your context files
* A `nao_config.yaml` configuration file
* A `RULES.md` file
* A `tests/` folder with a starter `test_example.yml` test file

## Step 3: Verify your setup

cd to the project folder and run:

```bash theme={null}
nao debug
```

This command checks your configuration and displays any issues.

## Step 4: Synchronize your context

```bash theme={null}
nao sync
```

This will populate your context folder with your context files (data, metadata, repos, etc.).

## Step 5: Launch the chat and ask questions

You have two options to access the chat UI:

### Option 1: Using nao chat command

```bash theme={null}
nao chat
```

This will start the nao chat UI. It will open the chat interface in your browser at `http://localhost:5005`.

### Option 2: Using Docker

Instead of `nao chat`, you can use Docker to run the UI:

**With built-in example:**

```bash theme={null}
docker run -d \
  --name nao \
  -p 5005:5005 \
  -e BETTER_AUTH_URL=http://localhost:5005 \
  getnao/nao:latest
```

**With your project:**

```bash theme={null}
docker run -d \
  --name nao \
  -p 5005:5005 \
  -e BETTER_AUTH_URL=http://localhost:5005 \
  -v /path/to/your/project:/app/project \
  -e NAO_DEFAULT_PROJECT_PATH=/app/project \
  getnao/nao:latest
```

Access the UI at `http://localhost:5005` and add your LLM API key in the settings.

From there, you can start asking questions to your agent!

## Step 6: Evaluate your agent

`nao init` scaffolds a starter test file at `tests/basic_arithmetic.yml`. You can add more test files with questions and expected SQL in YAML format, then measure your agent's performance:

```bash theme={null}
nao test
```

View results in tests panel:

```bash theme={null}
nao test server
```

<Card title="Evaluation Guide" icon="flask" href="/nao-agent/context-engineering/evaluation">
  Learn how to build comprehensive test suites and evaluate your agent
</Card>

## What's Next?

<CardGroup cols={2}>
  <Card title="Skills" icon="wand-magic-sparkles" href="/nao-agent/context-engineering/skills">
    Install five published skills to let your agentic CLI automate setup, rules, tests, and audits
  </Card>

  <Card title="Context Builder" icon="cube" href="/nao-agent/context-builder/overview">
    Learn how to build and customize your agent's context
  </Card>

  <Card title="Self-Hosting" icon="server" href="/nao-agent/self-hosting/deployment-guide">
    Deploy your agent in production
  </Card>

  <Card title="Chat Interface" icon="comments" href="/nao-agent/chat/overview">
    Explore the chat interface features
  </Card>

  <Card title="nao Cloud" icon="cloud" href="/nao-agent/cloud/overview">
    Use our managed cloud service
  </Card>
</CardGroup>