Skip to content

常见工作流

一次性任务(print)

bash
forgeax -p "解释 src/main.ts 的启动顺序"
forgeax --print "给 README 补一节安装说明的草稿"

适合脚本、CI、以及「问完即走」。

输出格式

bash
forgeax -p "..." --output-format text          # 默认,人类可读
forgeax -p "..." --output-format json          # 单结果对象
forgeax -p "..." --output-format stream-json   # 每事件一行 NDJSON

交互 REPL / TUI

bash
forgeax                 # TTY → Ink TUI
forgeax --no-tui        # 强制 readline

在项目根目录启动,便于自动发现 .forgeax/*

续聊与会话

会话默认落在 ./.forgeax/sessions/(可用 --sessions-dir 改):

bash
forgeax -c                         # 续本目录最近一次会话;没有则新建
forgeax --resume <session-id>      # 指名续接(或以此 id 新建)
forgeax --session-id <id> -p "..." # 显式指定 id(别名语义与 resume 对齐)

跨进程多轮依赖磁盘 WAL;临时跑(未指定 session)默认不持久化。

管道与重定向

stdin 非 TTY 时,CLI 会读入管道内容并与 -p 提示一起交给 agent:

bash
git log --oneline -n 30 | forgeax -p "按风险排序这些提交"
git diff main...HEAD | forgeax -p "写一段 PR 说明(中文)"
cat build.log | forgeax -p "定位失败根因并给修复步骤"

扩展思考

bash
forgeax -p "设计一个缓存失效策略" --thinking
forgeax -p "..." --thinking 8000    # 可选 token budget

Skills / Commands / Plugins

bash
forgeax --skills ./my-skills,~/.forgeax/skills
forgeax --commands ./.forgeax/commands
forgeax --plugins ./plugins

不传时自动扫描项目与用户目录(见快速开始)。

MCP

bash
forgeax --mcp ./.forgeax/mcp.json
forgeax --mcp-token github=GITHUB_TOKEN

细节见 MCP。反向暴露本机工具给其他 MCP 客户端:

bash
forgeax mcp-serve
forgeax mcp-serve --allow-writes   # 允许改动型工具(默认偏只读)

权限姿态

bash
forgeax --permission-mode default
forgeax --permission-mode acceptEdits
forgeax --permission-mode plan
# 危险:自动批准全部权限提示(root 下拒绝)
forgeax --yes

声明式规则写在 settings,见权限

OS 沙箱(Bash)

bash
forgeax --sandbox      # 或 FORGEAX_SANDBOX=1 / settings.sandbox.enabled
forgeax --no-sandbox

macOS 使用 Seatbelt,Linux 使用 bwrap;不可用时会明确降级(不会静默假装已沙箱)。

内存

bash
forgeax --memory ./.forgeax/memory
forgeax --no-memory

Hooks

bash
forgeax --hooks ./hooks.json

配置可为顶层 hooks map,或 { "hooks": { ... } } 包裹。

Web 搜索

bash
forgeax --search-url https://search.example/api
# 或环境变量 FORGEAX_SEARCH_URL / BRAVE_API_KEY

未配置时 web_search 工具会隐藏,避免空后端。

Studio sidecar(进阶)

bash
forgeax --serve --sock /tmp/forgeax.sock

把内核以 JSON-RPC sidecar 暴露给宿主(Studio / orchestrator)。日常 CLI 用户一般不需要。

Apache-2.0 · 开源