git clone https://github.com/TinyAGI/tinyagi.git
cd tinyagi && npm install && npm run build
npx tinyagi start
npx tinyagi agent list

从源码安装：

git clone https://github.com/TinyAGI/tinyagi.git
cd tinyagi && npm install && ./scripts/install.sh

docker compose up -d

您可以在.env文件中设置API密钥，或直接传递：

ANTHROPIC_API_KEY=sk-ant-... docker compose up -d

API将在http://localhost:3777上运行。数据将持久化存储在名为tinyagi-data的Docker卷中。

Discord设置

1. 访问Discord开发者门户
2. 创建应用 → 机器人部分 → 创建机器人
3. 复制机器人令牌
4. 启用“消息内容意图”
5. 使用OAuth2 URL生成器邀请机器人

Telegram设置

1. 打开Telegram → 搜索@BotFather
2. 发送/newbot → 按照提示操作
3. 复制机器人令牌
4. 开始与您的机器人聊天

WhatsApp设置

在启动TinyAGI后，请扫描二维码：

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
     WhatsApp QR Code
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
[QR CODE HERE]

📱 设置 → 已链接设备 → 链接设备

• 仪表板 - 实时队列/系统概览和实时事件流
• 聊天控制台 - 向默认智能体、@agent或@team发送消息
• 智能体与团队 - 创建、编辑和删除智能体/团队
• 任务（看板） - 创建任务，在不同阶段间拖动，分配给智能体/团队
• 日志与事件 - 查看队列日志和流式事件
• 设置 - 通过UI编辑TinyAGI配置文件（settings.json）
• 办公视图 - 智能体交互的可视化模拟
• 组织架构图 - 团队和智能体的层级可视化
• 聊天室 - 类似Slack的团队持久化聊天室
• 项目 - 基于项目的任务管理，配有筛选后的看板

本地运行

首先启动TinyAGI（API默认地址：http://localhost:3777），然后：

tinyagi office

该命令会自动检测是否需要依赖项或构建（例如在tinyagi update之后），并在http://localhost:3000上启动生产服务器。

若需开发并启用热重载：

cd tinyoffice
npm install
npm run dev

如果TinyAGI API位于不同的主机或端口，请设置：

cd tinyoffice
echo 'NEXT_PUBLIC_API_URL=http://localhost:3777' > .env.local

自定义提供商允许您使用任何与 OpenAI 或 Anthropic 兼容的 API 端点（例如 OpenRouter、代理服务器、自托管模型）。

在 settings.json 中定义自定义提供商：

{
  "custom_providers": {
    "my-proxy": {
      "name": "My Proxy",
      "harness": "claude",
      "base_url": "https://proxy.example.com/v1",
      "api_key": "sk-...",
      "model": "claude-sonnet-4-6"
    }
  }
}

为代理分配自定义提供商：

tinyagi agent provider coder custom:my-proxy
tinyagi agent provider coder custom:my-proxy --model gpt-4o

认证令牌存储 — 存储内置提供商的凭据，这样就不需要单独的 CLI 认证了：

tinyagi provider anthropic --oauth-token sk-ant-oat01-...
tinyagi provider anthropic --api-key sk-ant-...
tinyagi provider openai --api-key sk-...

Anthropic 同时支持 oauth_token（导出为 CLAUDE_CODE_OAUTH_TOKEN）和 api_key（导出为 ANTHROPIC_API_KEY）。如果两者都已设置，OAuth 会优先使用。OpenAI 的密钥则保存为 models.openai.api_key，并导出为 OPENAI_API_KEY。若未进行任何配置，程序将直接继承环境变量。

API 端点：

GET    /api/custom-providers              # 列出自定义提供商
PUT    /api/custom-providers/:id          # 创建或更新
DELETE /api/custom-providers/:id          # 删除

更多详情请参阅 docs/AGENTS.md。

使用发送者配对功能来控制哪些用户可以向你的代理发送消息。

配对行为：

• 来自未知发送者的首次消息：TinyAGI 会生成一个代码，并发送批准说明。
• 在待处理期间的后续消息：TinyAGI 会静默拦截（不会重复发送配对消息）。
• 批准后：该发送者的消息将被正常处理。

这些命令在 Discord、Telegram 和 WhatsApp 中均可使用：

注意： @agent_id 路由前缀后需要空格（例如，@coder fix 而不是 @coderfix）。

访问控制说明： 在路由之前，频道客户端会先检查发送者的配对白名单。

注意： 如果您使用的是 v0.0.1 或 v0.0.2 版本，更新脚本可能存在故障。请重新安装：

curl -fsSL https://raw.githubusercontent.com/TinyAGI/tinyagi/main/scripts/install.sh | bash

您的设置和用户数据将会保留。

自动检测： TinyAGI 会在启动时检查更新（每小时一次）。

禁用更新检查：

export TINYAGI_SKIP_UPDATE_CHECK=1

代理配置位于 .tinyagi/settings.json 文件中：

{
  "agents": {
    "coder": {
      "name": "代码助手",
      "provider": "anthropic",
      "model": "sonnet",
      "working_directory": "/Users/me/tinyagi-workspace/coder"
    },
    "writer": {
      "name": "技术文档撰写员",
      "provider": "custom:my-proxy",
      "model": "gpt-5.3-codex",
      "working_directory": "/Users/me/tinyagi-workspace/writer"
    }
  }
}

每个代理独立运行：

• 独立的工作目录 - ~/tinyagi-workspace/{agent_id}/
• 独立的对话历史 - 由 CLI 维护
• 自定义配置 - .claude/、heartbeat.md（根目录）、AGENTS.md
• 独立重置 - 可单独重置每个代理的对话

有关架构、使用场景及高级功能的完整详情，请参阅 docs/AGENTS.md。

┌─────────────────────────────────────────────────────────────┐
│                     消息通道                         │
│         (Discord, Telegram, WhatsApp, Web, API)             │
└────────────────────┬────────────────────────────────────────┘
                     │ enqueueMessage()
                     ↓
┌─────────────────────────────────────────────────────────────┐
│               ~/.tinyagi/tinyagi.db (SQLite)               │
│                                                              │
│  messages: 待处理 → 处理中 → 完成 / 死信          │
│  responses: 待确认 → 已确认                                  │
│                                                              │
└────────────────────┬────────────────────────────────────────┘
                     │ 队列处理器
                     ↓
┌─────────────────────────────────────────────────────────────┐
│              并行代理处理                    │
│                                                              │
│  代码员代理        写作代理       助理代理   │
│  ┌──────────┐       ┌──────────┐        ┌──────────┐       │
│  │ 消息 1│       │ 消息 1│        │ 消息 1│       │
│  │ 消息 2│ ...   │ 消息 2│  ...   │ 消息 2│ ...   │
│  │ 消息 3│       │          │        │          │       │
│  └────┬─────┘       └────┬─────┘        └────┬─────┘       │
│       │                  │                     │            │
└───────┼──────────────────┼─────────────────────┼────────────┘
        ↓                  ↓                     ↓
   claude CLI         claude CLI             claude CLI
  (workspace/coder)  (workspace/writer)  (workspace/assistant)

位于 .tinyagi/settings.json：

{
  "channels": {
    "enabled": ["discord", "telegram", "whatsapp"],
    "discord": { "bot_token": "..." },
    "telegram": { "bot_token": "..." },
    "whatsapp": {}
  },
  "workspace": {
    "path": "/Users/me/tinyagi-workspace",
    "name": "tinyagi-workspace"
  },
  "agents": {
    "tinyagi": {
      "name": "TinyAGI 代理",
      "provider": "anthropic",
      "model": "opus",
      "working_directory": "/Users/me/tinyagi-workspace/tinyagi"
    }
  },
  "teams": {
    "dev": {
      "name": "开发团队",
      "agents": ["coder", "reviewer"],
      "leader_agent": "coder"
    }
  },
  "custom_providers": {
    "my-proxy": {
      "name": "我的代理",
      "harness": "claude",
      "base_url": "https://proxy.example.com/v1",
      "api_key": "sk-...",
      "model": "claude-sonnet-4-6"
    }
  },
  "models": {
    "anthropic": { "api_key": "sk-ant-...", "oauth_token": "sk-ant-oat01-..." },
    "openai": { "api_key": "sk-..." }
  },
  "monitoring": {
    "heartbeat_interval": 3600
  }
}

编辑代理特定的心跳提示：

nano ~/tinyagi-workspace/coder/heartbeat.md

默认心跳提示：

检查以下内容：

1. 待处理的任务
2. 错误
3. 未读消息

如有需要，请采取行动。

tinyagi/
├── packages/                # 单体仓库包
│   ├── core/                #   共享类型、配置、队列、代理调用
│   ├── main/                #   队列处理器入口点
│   ├── teams/               #   团队对话编排
│   ├── server/              #   API 服务器 (REST + SSE)
│   ├── channels/            #   通道客户端 (Discord、Telegram、WhatsApp)
│   ├── cli/                 #   CLI 命令
│   └── visualizer/          #   TUI 仪表盘和聊天室查看器
├── tinyoffice/              # TinyOffice 网页门户 (Next.js)
├── .tinyagi/               # TinyAGI 数据 (运行时创建)
│   ├── settings.json        #   配置
│   ├── tinyagi.db          #   SQLite 队列数据库
│   ├── logs/                #   所有日志
│   ├── channels/            #   通道状态
│   ├── files/               #   上传的文件
│   ├── pairing.json         #   发送者白名单状态
│   ├── chats/               #   团队对话历史
│   │   └── {team_id}/       #     每个团队的聊天记录
│   ├── .claude/             #   代理模板
│   ├── heartbeat.md         #   代理模板
│   └── AGENTS.md            #   代理模板
├── ~/tinyagi-workspace/    # 代理工作空间
│   ├── tinyagi/            #   默认代理
│   ├── coder/
│   └── writer/
└── scripts/                 # 安装脚本

个人 AI 助手

你: “提醒我给妈妈打电话”
Claude: “好的，我会提醒你的！”
[1 小时后通过心跳]
Claude: “别忘了给妈妈打电话哦！”

多代理工作流

@coder 审查并修复 auth.ts 中的错误
@writer 记录更改内容
@reviewer 检查文档质量

团队协作

@dev 修复认证漏洞
# → 路由到团队负责人 (@coder)
# → 代码员修复漏洞，并在回复中提及 @reviewer
# → 审核员自动被调用，审核更改内容
# → 综合回复发送回用户

团队支持顺序链（单次交接）和并行扇出（多次提及队友）。详情请参阅 docs/TEAMS.md。

跨设备访问

• 手机上使用 WhatsApp，桌面端使用 Discord，任何地方都可以使用 Telegram，CLI 用于自动化
• 所有通道共享代理对话！

# 重置所有内容（保留设置）
tinyagi stop && rm -rf .tinyagi/queue/* && tinyagi start

# 重置 WhatsApp
tinyagi channels reset whatsapp

# 检查状态
tinyagi status

# 查看日志
tinyagi logs all

常见问题：

• WhatsApp 无法连接 → 重置认证：tinyagi channels reset whatsapp
• 消息卡住 → 清空队列：rm -rf .tinyagi/queue/processing/*
• 未找到代理 → 检查：tinyagi agent list
• settings.json 文件损坏 → TinyAGI 会自动修复无效的 JSON（如尾部逗号、注释、BOM），并创建一个 .bak 备份文件