@vionwilliams/agent-os 1.0.0-alpha.8 → 1.0.0-alpha.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +71 -3
  2. package/dist/cli.js +760 -741
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  > 智能任务通用工作系统 · 多模型路由 + 意图编排 + 多智能体协调 + DataHub + 可编程面板 + LLM 知识编译器
4
4
 
5
- **Status**: `1.0.0-alpha.8` · Beta 测试版 · npm 公共包可用
5
+ **Status**: `1.0.0-alpha.9` · Beta 测试版 · npm 公共包可用
6
6
 
7
7
  ---
8
8
 
@@ -35,6 +35,18 @@ Agent-OS 是一套面向真实工作的 AI 操作系统。它把**多模型路
35
35
 
36
36
  ## 快速开始
37
37
 
38
+ ### 0. 前置环境
39
+
40
+ ```bash
41
+ node -v
42
+ bun -v
43
+ ```
44
+
45
+ 要求:
46
+
47
+ - Node.js `>= 20`
48
+ - Bun `>= 1.3.0`
49
+
38
50
  ### 1. npm 安装(推荐)
39
51
 
40
52
  ```bash
@@ -49,6 +61,8 @@ curl -fsSL https://raw.githubusercontent.com/VIONWILLIAMS/agent-os/main/scripts/
49
61
  agent-os --version
50
62
  ```
51
63
 
64
+ > 注意:二进制安装依赖 GitHub Releases 的 latest 标签;若 release 未同步到最新版本,优先使用 npm 安装。
65
+
52
66
  ### 3. 从源码运行(开发者)
53
67
 
54
68
  ```bash
@@ -59,8 +73,6 @@ bash scripts/build.sh
59
73
  bun dist/cli.js --version
60
74
  ```
61
75
 
62
- 前置环境:[Bun](https://bun.sh) `>= 1.3.0`
63
-
64
76
  ---
65
77
 
66
78
  ## Provider 配置示例
@@ -114,6 +126,26 @@ agent-os --help
114
126
 
115
127
  ---
116
128
 
129
+ ## 新用户首跑验收(建议 3 分钟完成)
130
+
131
+ ```bash
132
+ # 1) 版本确认
133
+ agent-os --version
134
+
135
+ # 2) 配置一组 provider(示例:DeepSeek)
136
+ export MODEL_PROVIDER="deepseek"
137
+ export MODEL_BASE_URL="https://api.deepseek.com/v1"
138
+ export MODEL_API_KEY="your-key"
139
+ export MODEL_NAME="deepseek-chat"
140
+
141
+ # 3) 打开路由调试并做最小请求
142
+ MODEL_DEBUG=1 agent-os -p "Reply with exactly: pong" < /dev/null
143
+ ```
144
+
145
+ 若返回 `pong` 且日志里看到 `resolved config`,说明安装与路由链路正常。
146
+
147
+ ---
148
+
117
149
  ## Router 配置优先级
118
150
 
119
151
  Router 配置按优先级从高到低解析:
@@ -127,6 +159,7 @@ Router 配置按优先级从高到低解析:
127
159
 
128
160
  - 命中更高优先级后,低优先级不生效。
129
161
  - 推荐在项目里使用 `model-router.json` 固化团队默认路由。
162
+ - 用户级默认目录为 `~/.agent-os/`(兼容变量可覆盖,详见 `docs/ROUTER.md`)。
130
163
 
131
164
  ---
132
165
 
@@ -146,6 +179,40 @@ Router 配置按优先级从高到低解析:
146
179
 
147
180
  ---
148
181
 
182
+ ## 常见问题(安装与首跑)
183
+
184
+ ### 1) `agent-os --version` 显示旧版本
185
+
186
+ 先确认命令来源:
187
+
188
+ ```bash
189
+ which agent-os
190
+ type agent-os
191
+ ```
192
+
193
+ 如果你本地有自定义 alias/function,会覆盖 npm 全局安装。
194
+
195
+ ### 2) `[provider] API error 401 invalid api key`
196
+
197
+ 优先排查环境变量污染:
198
+
199
+ ```bash
200
+ unset MODEL_API_KEY MINIMAX_API_KEY DEEPSEEK_API_KEY
201
+ ```
202
+
203
+ 然后只保留一组 provider 配置重试,并开启 `MODEL_DEBUG=1` 观察实际命中 provider/baseUrl/model。
204
+
205
+ ### 3) 不确定配置文件放在哪里
206
+
207
+ 默认看:
208
+
209
+ - `~/.agent-os/model-router.json`
210
+ - `~/.agent-os/providers.json`
211
+
212
+ 更多细节见:[`docs/ROUTER.md`](./docs/ROUTER.md)。
213
+
214
+ ---
215
+
149
216
  ## 主要目录
150
217
 
151
218
  ```text
@@ -171,6 +238,7 @@ packages/
171
238
 
172
239
  - `alpha.7`:产品定位与 npm 介绍升级
173
240
  - `alpha.8`:README 全量去品牌化清稿
241
+ - `alpha.9`:新用户首跑闭环补齐(版本一致性 / Router 文档 / 401 排障)
174
242
  - `beta.1`:知识编译器与协调层深度联动稳定化
175
243
  - `beta.2`:发布链路与文档体系标准化
176
244