Prefer to run nao on your own infrastructure? See the Deployment Guide. The organization and project model below is the same in both.
Step 1: Create your account
Go to app.getnao.io/signup and sign up with Google or email and password.
Step 2: Explore the example project
Before you connect your own data, your home page opens on Jaffle Shop, a fictional retail dataset with customers, orders, and payments. Use it to see how nao works:- Ask one of the suggested ideas, such as “How is monthly revenue trending?” or “Create a story, using chart blocks, summarizing our sales performance and key customer trends.”
- Open the example story Jaffle Shop: Revenue, Order Status & Top Customers from the stories grid.
- Attach your own files to a chat to analyze them.
Step 3: Set up your project with the onboarding agent
Click Set up on the Start using your data card in the sidebar to open the onboarding agent at app.getnao.io/onboarding. It asks where you are starting from and guides you through one of four paths:
When your first project is fully set up (a database is configured and every required environment variable is set), your free trial starts and $20 of nao credits are added to your organization.
Onboarding agent
Every setup path in detail, including supported warehouses and what nao does in the background
Configure the project
Your data connections, rules, and semantics are defined innao_config.yaml and your context folder. A few things are set directly in the Cloud UI:
- Project name, environment variables - open Settings -> Project Settings. Admins can rename the project from the Information card.
- Budgets - open Settings -> Budget.
- Models and agent capabilities - open Settings -> Agent, then choose the Models or Capabilities tab. Use the managed nao models with your credits, or add your own API key.
- MCP servers and messaging integrations - open Settings -> Integrations & MCP.
Step 4: Invite your team
Add teammates from Settings -> Members: invite by email and pick a role. Each new member signs in with their email and the generated password. Members join projects to get access to that project’s chats, context, and data. For roles and permissions, see Admin Setup.On Cloud, users who sign in with a Google address on your organization’s claimed domain can join automatically - no manual invite needed.
Step 5: Start chatting
Open your project and ask a question in plain English. The agent uses your project’s context to write SQL, run it against your connected warehouse, and return results and charts.nao deploy reference
Thenao deploy command packages a local nao project and uploads it to a remote nao instance. It is the bridge between a project built locally with nao init / nao sync and a Cloud (or self-hosted) instance that runs chats, scheduled jobs, and integrations against that project.
Prerequisites
- A remote nao instance URL (Cloud workspace or your self-hosted deployment).
- An organization-level API key - create one from Settings -> Organization Settings -> Organization API Keys (see Deploy from the CLI).
- A local project with a valid
nao_config.yamlthat has aproject_namefield.
Command
Run from the project directory (the folder that containsnao_config.yaml), or point at it with --path:
What gets uploaded
nao deploy builds a gzipped tarball of the project folder and uploads it to <url>/api/deploy. The server extracts the archive, reads project_name from nao_config.yaml, and either creates a new project or updates the existing one with the same name.
These paths are always skipped when building the archive: .git, .venv, .env, node_modules, __pycache__, repos, *.pyc. The server refuses (with a 400) any archive that still contains Git metadata, such as a .git folder or file at any depth.
Add a .naoignore file at the project root to exclude extra files (one pattern per line, # for comments):
Create vs update
The server looks up a project by(organization, project_name):
- If no project with that name exists, a new one is created (
status: "created"). - If one already exists, its context folder is replaced with the uploaded content (
status: "updated").
Errors
Authentication failed. Check your API key.- the API key is missing, revoked, or does not belong to the target organization.No nao_config.yaml found in current directory- run from a project root or pass--path.nao_config.yaml is missing a 'project_name' field- addproject_name: my_projectat the top ofnao_config.yaml.Could not connect to <url>- check the URL and that the instance is reachable from your network.
What’s next
Context Builder
Structure the databases, repos, rules, and semantics your agent reads from
Host multiple projects
Run several projects in one workspace with a project switcher
Git Repository Setup
Automate context deploys with GitHub Actions
Chat Interface
Stories, memory, automations, and admin tools