@fastagent/cli 0.0.2 → 0.2.0

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 +105 -3
  2. package/cli.js +365 -301
  3. package/package.json +14 -2
package/README.md CHANGED
@@ -1,8 +1,30 @@
1
1
  # @fastagent/cli
2
2
 
3
- FastAgent 是一个面向工具接入、skills、MCP、IM 通道接入、子智能体、计划任务与多智能体调度场景的 agentic 执行引擎命令行入口。
3
+ `@fastagent/cli` 是 FastAgent 的公开命令行工具。你可以用它在本地运行 FastAgent、接入内置 IM 通道、安装 skills,并使用一组面向长会话和自动化场景的工程化能力,例如记忆、上下文压缩、任务调度和 sandbox 路由。
4
4
 
5
- 通过 `fastagent` 命令,你可以用统一方式启动和使用 FastAgent;当前公开命令面已开放其中一部分能力,并会持续扩展。
5
+ 它适合这些场景:
6
+
7
+ - 把 FastAgent 作为本地 CLI agent 使用
8
+ - 通过内置 IM 通道把 FastAgent 跑成 IM 服务
9
+ - 在一个统一入口下使用文件、搜索、MCP、skills,以及记忆、上下文压缩、定时任务、计划清单和后台任务控制等工程化能力
10
+
11
+ ## 能力概览
12
+
13
+ 当前版本主要聚焦长会话和自动化场景下的工程化运行能力:
14
+
15
+ - 文件读取、写入和编辑
16
+ - 文件搜索与内容搜索
17
+ - 命令执行与进程管理
18
+ - MCP 工具接入与 MCP 资源读取
19
+ - skills 安装、发现和调用
20
+ - 记忆:从 project / user 记忆目录召回可复用的长期信息,并在稳定回合后沉淀新的记忆
21
+ - 上下文压缩:长会话自动压缩历史上下文,优先复用 session checkpoint,必要时回退到摘要压缩
22
+ - 定时任务(`cron`):会话级持久化定时调度
23
+ - 计划清单:管理会话内的任务列表
24
+ - 后台任务控制:查看、等待和停止子智能体 / 后台运行任务
25
+ - local / remote sandbox 运行模式
26
+
27
+ 这些能力很多会在运行时自动生效,当前并不都会以独立子命令的形式直接暴露。
6
28
 
7
29
  ## 安装
8
30
 
@@ -22,19 +44,99 @@ fastagent --help
22
44
  fastagent
23
45
  fastagent --channel weixin
24
46
  fastagent --channel weixin --output jsonl
47
+ fastagent --channel weixin --sandbox local
48
+ fastagent --channel weixin --sandbox remote --sandbox-url http://127.0.0.1:8788
25
49
  fastagent config
26
50
  fastagent doctor
27
51
  fastagent skills add <source>
28
52
  fastagent skills list
29
53
  ```
30
54
 
31
- ## 示例
55
+ 当前 `fastagent` 裸命令默认显示帮助信息;如果你想直接启动一个可工作的服务入口,优先从 IM 通道开始。
56
+
57
+ ## IM Channel
58
+
59
+ 当前公开提供的内置 IM 通道是微信 `weixin`。
60
+
61
+ 你可以用它把 FastAgent 作为一个微信机器人运行,支持:
62
+
63
+ - 扫码登录
64
+ - 已有登录态恢复
65
+ - 入站图片进入模型上下文,作为真实 image prompt block 参与推理
66
+ - 入站语音复用微信已提供的转写文本,不额外执行本地 STT
67
+ - 入站文件 / 视频持久化保存,当前不直接送入模型
68
+ - 文本模式输出
69
+ - `jsonl` 机器输出
70
+ - `local` / `remote` sandbox 路由
71
+
72
+ 当前出站仍以文本回复为主,暂不提供出站媒体发送。
73
+
74
+ ### 启动前需要的环境变量
75
+
76
+ 必填:
77
+
78
+ ```bash
79
+ # 用户工作区(项目级)
80
+ export IM_GATEWAY_WORKSPACE_DIR=/weixin-bot/workspace
81
+ # 全局/用户级数据目录
82
+ export IM_GATEWAY_DATA_DIR=/weixin-bot/data
83
+ # AI名字可任意命名
84
+ export IM_GATEWAY_AGENT_ID=weixin-bot
85
+ # 默认允许全部权限
86
+ export IM_GATEWAY_ALLOW_ALL_PERMISSIONS=true
87
+ ```
88
+
89
+ LLM 最小示例:
90
+
91
+ ```bash
92
+ export FASTAGENT_PROVIDER=anthropic
93
+ export FASTAGENT_MODEL=claude-opus-4-6
94
+ export ANTHROPIC_API_KEY=<your-key>
95
+ ```
96
+
97
+ 常见可选项:
98
+
99
+ ```bash
100
+ export FASTAGENT_API_KEY=<your-key>
101
+ export FASTAGENT_API_TYPE=openai-responses
102
+ export FASTAGENT_BASE_URL=https://api.openai.com/v1
103
+ export FASTAGENT_USER_AGENT=your-app-name
104
+ ```
105
+
106
+ ### 启动微信服务
107
+
108
+ ```bash
109
+ fastagent --channel weixin
110
+ ```
111
+
112
+ 机器可读输出:
113
+
114
+ ```bash
115
+ fastagent --channel weixin --output jsonl
116
+ ```
117
+
118
+ 远端 sandbox:
119
+
120
+ ```bash
121
+ fastagent --channel weixin --sandbox remote --sandbox-url http://127.0.0.1:8788
122
+ ```
123
+
124
+ 如果你要在 npm 安装态启用 `--sandbox local`,需要满足以下其一:
125
+
126
+ - 通过 `FASTAGENT_SANDBOX_RUNTIME_BIN` 和可选 `FASTAGENT_SANDBOX_RUNTIME_ARGS` 显式指定 launcher
127
+ - 单独安装 `@fastagent/sandbox-runtime`,让包提供 `fastagent-sandbox`
128
+ - 让 `fastagent-sandbox` 已经存在于 PATH 中
129
+
130
+ ## 常见用例
32
131
 
33
132
  ```bash
34
133
  fastagent --help
35
134
  fastagent --version
36
135
  fastagent --channel weixin
37
136
  fastagent --channel weixin --output jsonl
137
+ fastagent --channel weixin --sandbox local
138
+ fastagent skills add owner/repo
139
+ fastagent skills add ./skills/review-pr --scope project
38
140
  fastagent config
39
141
  fastagent doctor
40
142
  fastagent skills list