Skip to main content

​
Step 1: Install nao-core package

pip install nao-core

​
Step 2: Initialize a nao project

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)
You can skip any optional question and configure them later in your nao_config.yaml file.
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

​
Step 3: Verify your setup

cd to the project folder and run: 
nao debug
This command checks your configuration and displays any issues.

​
Step 4: Synchronize your context

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

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: 
docker run -d \
  --name nao \
  -p 5005:5005 \
  -e BETTER_AUTH_URL=http://localhost:5005 \
  -e FASTAPI_URL=http://127.0.0.1:8005 \
  getnao/nao:latest
With your project: 
docker run -d \
  --name nao \
  -p 5005:5005 \
  -e BETTER_AUTH_URL=http://localhost:5005 \
  -e FASTAPI_URL=http://127.0.0.1:8005 \
  -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

First, create a folder tests/ with questions and expected SQL in yaml. Then, mesure agent’s performance on examples with nao test command: 
nao test
View results in tests panel: 
nao test server

Evaluation Guide

Learn how to build comprehensive test suites and evaluate your agent

​
What’s Next?

Context Builder

Learn how to build and customize your agent’s context

Self-Hosting

Deploy your agent in production

Chat Interface

Explore the chat interface features

nao Cloud

Use our managed cloud service