快速开始
🔵 目标是在几分钟内启动 Agent OS 并看到运行中的智能体:
打开小组件并与 hello-agent 对话——它是起始配置中的演示智能体。
2.1 启动
需要已编译的二进制文件 agent-os(统一 CLI,子命令 serve)以及
config/ 目录树。发行版(下载)中两者都有:
二进制文件位于 bin/,起始配置位于 config/。
服务器从解压后的归档根目录启动——config/ 和 .env
相对于当前文件夹查找,而不是在二进制文件旁边:
agent-os-distrib/ ← 从这里启动
├── bin/agent-os
├── config/
├── .env.example
└── .env ← 由你创建
API 密钥放在 .env 中——机密只放那里,不要放进 YAML:
cp .env.example .env # Windows: copy .env.example .env
打开 .env 并将你的密钥填入 DEEPSEEK_API_KEY(AGENT_OS_API_KEY 也可以)。
模板中其余行都已注释——无需改动。密钥是可选的:没有它服务器也能启动,
智能体会返回模拟回复(日志中会出现警告)。
然后启动:
./bin/agent-os serve # Windows: bin\agent-os.exe serve
服务器在 127.0.0.1:3000 上启动。使用其他地址——通过变量
(在 .env 或环境中):
AGENT_OS_BIND=0.0.0.0:8080 ./bin/agent-os serve
检查服务器是否存活以及加载了哪些智能体:
curl http://127.0.0.1:3000/health
在 templates 字段中应当有 hello-agent 和 mcp-demo-agent。
2.2 立即看到智能体
在浏览器中打开:
http://127.0.0.1:3000/widget?model=hello-agent
这是小组件页面,已直接连接到智能体 hello-agent——可以直接在
聊天中输入。让它统计文本中的单词或字符数:它会调用自己的
工具 text_stats(来自
config/agents/hello/tools/ 的 JavaScript 脚本)。
在 ?model= 中指定的是模板名称——agent.yaml 中的 name:
字段(hello-agent),而不是文件夹名称(hello)。
第二个演示智能体 mcp-demo-agent 通过外部 MCP 服务器读取文件,
需要安装 Node.js(PATH 中的 npx);没有 Node 时它也能加载,但
调用工具会返回错误。
其他现成页面:
| URL | 说明 |
|---|---|
/widget?model=hello-agent |
带特定智能体的小组件 |
/demo |
小组件演示 |
/demo/overlay |
覆盖在实时网站上的小组件(来自 config/demo.yaml 的标签页) |
/site/ |
来自 config/web/ 的 markdown 网站 |
/sessions, /dashboard |
管理面板(会话、系统状态) |
/v1/templates |
可用智能体模板列表 |
起始配置中既没有 config/web/,也没有 config/demo.yaml,因此
/site/ 返回 404,而 /demo/overlay 没有标签页——直到你
添加它们为止。网站描述见 13-web-content;覆盖层
标签页在 config/demo.yaml 中设置(tabs: [{label, url, model}],
实时热重载)。
2.3 提供商——不只是 DeepSeek
模型在 provider 块中的 config/server.yaml 里指定。默认是
DeepSeek,但任何 OpenAI 兼容 API 和本地模型都适用:
provider:
base_url: "https://api.deepseek.com"
model: "deepseek-chat"
api_key: "" # пусто → ключ берётся из .env
示例:
- Ollama(本地):
base_url: "http://localhost:11434/v1",model: "llama3"。 - OpenAI:
base_url: "https://api.openai.com/v1",model: "gpt-4o"。
提供商地址和模型只在这里指定;任何提供商的密钥
都放在 .env 中作为 AGENT_OS_API_KEY(或 DEEPSEEK_API_KEY)。像
OPENAI_API_KEY、OPENAI_BASE_URL 和 AGENT_OS_MODEL 这样的变量服务器不会读取。
同时使用多个模型——通过命名配置 models:;智能体
模板通过其 agent.yaml 中的 model: 字段选择所需的配置。
2.4 通过 API 对话
对于集成,同样的对话可通过聊天端点(SSE 流)访问:
curl http://127.0.0.1:3000/v1/chat/completions \
-H 'Content-Type: application/json' \
-d '{"model":"hello-agent","messages":[{"role":"user","content":"Привет!"}]}'
这里 model 是智能体模板名称。完整的请求和事件格式见
08-http-api。
2.5 嵌入小组件
在网站的任何页面上:
<script src="http://127.0.0.1:3000/widget.js"></script>
2.6 接下来做什么
- 配置服务器(提供商、调度器、预算、auth)→
03-server-configuration。 - 创建你自己的智能体 →
04-building-an-agent。