getnao/nao

nao - 领先的开源分析代理

nao是一个用于构建和部署分析代理的框架。通过nao-core CLI为分析代理创建上下文，然后部署聊天UI，让任何人都能与您的数据交互。

🌐 官网 · 📚 文档 · 💬 Slack · 🐙 https://github.com/getnao/nao

Docker

支持的标签

• latest - 最新稳定版本
• commit-hash - 特定提交哈希标签

支持的架构

• linux/amd64

基础镜像

• Python 3.12 (slim)，包含Node.js 24和Bun

快速开始

使用Docker Run（SQLite数据库）

bash
docker run -d \
  --name nao \
  -p 5005:5005 \
  -e OPENAI_API_KEY=sk-... \
  -v /path/to/your/project:/app/project \
  getnao/nao:latest

环境变量

* 进行AI查询至少需要一个LLM API密钥。

端口

卷

挂载nao项目目录，使其对代理可用：

bash
-v /path/to/your/nao-project:/app/project

然后设置NAO_DEFAULT_PROJECT_PATH=/app/project，也可通过设置NAO_DEFAULT_PROJECT_PATH=/app/example使用示例项目。

Docker run示例

bash
docker run -d \
  --name nao \
  -p 5005:5005 \
  -e NAO_DEFAULT_PROJECT_PATH=/app/project \
  getnao/nao:latest

然后访问http://localhost:5005（或您配置的任何URL）以使用UI。

基于Git的上下文

除了挂载卷，您还可以让容器在启动时从git仓库克隆nao项目：

bash
docker run -d \
  --name nao \
  -p 5005:5005 \
  -e OPENAI_API_KEY=sk-... \
  -e NAO_CONTEXT_SOURCE=git \
  -e NAO_CONTEXT_GIT_URL=https://github.com/your-org/your-nao-context.git \
  -e NAO_CONTEXT_GIT_BRANCH=main \
  -e NAO_CONTEXT_GIT_TOKEN=ghp_xxx \
  -e NAO_DEFAULT_PROJECT_PATH=/app/context \
  getnao/nao:latest

如果您的nao项目位于大型仓库的子文件夹中（如单体仓库），设置NAO_CONTEXT_GIT_SUBPATH，仅通过git稀疏检出该文件夹：

bash
-e NAO_CONTEXT_GIT_SUBPATH=analytics/finance

容器随后会在<NAO_DEFAULT_PROJECT_PATH>/<NAO_CONTEXT_GIT_SUBPATH>/nao_config.yaml位置查找nao_config.yaml。

SSH部署密钥认证

对于私有仓库，您可以使用https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys%E4%BB%A3%E6%9B%BF%E4%B8%AA%E4%BA%BA%E8%AE%BF%E9%97%AE%E4%BB%A4%E7%89%8C%E3%80%82%E4%BD%BF%E7%94%A8SSH URL（git@github.com:org/repo.git）并通过NAO_CONTEXT_GIT_SSH_KEY传递私钥内容：

bash
docker run -d \
  --name nao \
  -p 5005:5005 \
  -e OPENAI_API_KEY=sk-... \
  -e NAO_CONTEXT_SOURCE=git \
  -e NAO_CONTEXT_GIT_URL=git@github.com:your-org/your-nao-context.git \
  -e NAO_CONTEXT_GIT_SSH_KEY="$(cat ~/.ssh/nao_deploy_key)" \
  -e NAO_DEFAULT_PROJECT_PATH=/app/context \
  getnao/nao:latest

GitHub的主机密钥已预先固定，因此SSH主机验证是严格的（首次连接时无MITM风险）。

核心功能

• 🧱 开放上下文构建器 — 为您的代理创建文件系统上下文
• 🏳️ 数据栈无关 — 兼容任何数据仓库、技术栈和LLM
• 🔒 自托管与安全 — 使用您自己的LLM密钥，确保数据最大安全性
• 🤖 自然语言转洞察 — 用简单英语提问
• 📊 原生数据可视化 — 直接在聊天中创建可视化

许可证

Apache 2.0 - 参见https://github.com/naolabs/chat/blob/main/LICENSE