FORGEAX CLI · QUICKSTART
快速开始
从安装到第一次有意义的对话,只需几分钟。按顺序完成下面五步即可进入稳定工作流。
1. 安装
bash
npm install -g @forgeax/cli
forgeax --version若 npm 全局安装受限,也可用:
bash
npx @forgeax/cli -p "hi"
# 或从已 pack 的 tarball:
# npm install -g ./forgeax-cli-*.tgz2. 配置 API Key
默认走 Anthropic Messages 兼容族(也可切 OpenAI 兼容端点,见配置):
bash
export ANTHROPIC_API_KEY=YOUR_ANTHROPIC_API_KEY
# 可选:自建 / 网关
# export ANTHROPIC_BASE_URL=https://your-gateway.example/v1OpenAI 兼容族:
bash
export FORGEAX_PROVIDER_API=openai-compat
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY
export OPENAI_BASE_URL=https://api.openai.com/v1 # 或你的兼容网关没有 key 时,先用内置 echo 提供方验证安装:
bash
forgeax --demo -p "hi"3. 进入项目并启动
bash
cd /path/to/your/project
forgeax在 TTY 下会进入 Ink TUI;非 TTY 或加 --no-tui 时走 readline REPL。
一次性任务:
bash
forgeax -p "总结这个仓库的目录结构,并指出入口文件"4. 常用第一天动作
| 你想… | 怎么做 |
|---|---|
| 续上一次会话 | forgeax -c 或 forgeax --resume <id> |
| 只要机器可读结果 | forgeax -p "..." --output-format json |
| 吃管道输入 | git diff | forgeax -p "做代码审查" |
| 收紧自动改文件 | --permission-mode acceptEdits 或写 settings(见权限) |
| 检查环境 | 交互里用 /doctor(若已加载)或看故障排除 |
5. 项目约定目录(可选)
CLI 会自动发现:
| 路径 | 用途 |
|---|---|
.forgeax/settings.json | 项目共享设置(可提交) |
.forgeax/settings.local.json | 本机私有设置 |
.forgeax/skills/ · ~/.forgeax/skills/ | Skills |
.forgeax/commands/ | Markdown 斜杠命令 |
.forgeax/mcp.json · ~/.forgeax/mcp.json | MCP 服务 |
.forgeax/sessions/ | 会话 WAL(--resume / -c) |
.forgeax/memory/ | Auto-memory(可用 --no-memory 关) |
用户级全局配置默认在 ~/.forgeax/(可用 FORGEAX_CONFIG_DIR 覆盖)。