FORGEAX CLI · OVERVIEW
概述
终端原生的单 agent 运行时，把自然语言变成可检查、可继续、可交付的工程动作。
@forgeax/cli 是 ForgeaX 的自研原生内核，以一条全局命令 forgeax 交付。用自然语言描述需求，在终端里完成从读代码、改文件、跑命令到提交与排查的全链路辅助。
同一套源码还有两种形态（进阶）：--serve sidecar（Studio / 编排层内核）、以及可嵌入的 createAgent 库 API。本站面向 CLI 产品用户。
为什么选择 ForgeaX CLI？
用自然语言驱动开发与运维
描述你想做什么，而不是先翻一堆 flag。无论是改一个函数、梳理提交风险，还是排查错误日志，都可以用对话式交互完成。
终端原生，无缝集成
- 熟悉的环境：直接在命令行获得 AI 辅助，无需切换到另一个 IDE 专属界面
- 原生体验：支持主流操作系统与终端；TTY 下默认 Ink TUI，也可
--no-tui回落 readline - 零学习成本：保留原有 shell / Git / 脚本习惯，AI 叠在现有工作流之上
开箱即用的能力
- 内置工具链：读改文件、运行命令、Git、搜索、笔记本、Todo 等
- MCP：通过模型上下文协议接入第三方工具与服务
- Skills / Commands / Plugins：项目级与用户级目录自动发现
- 权限与沙箱：声明式
permissions规则；可选 OS 级 Bash 沙箱（macOS Seatbelt / Linux bwrap）
Unix 哲学的 AI 集成
- 管道友好：像
grep/awk一样吃标准输入 - 脚本集成：可嵌入 CI、Makefile、本地 hook
- 标准输入输出：支持重定向与管道组合
bash
# 管道集成示例
git log --oneline | forgeax -p "分析这些提交，找出可能的问题"
cat error.log | forgeax -p "帮我分析这些错误日志"快速体验
环境要求
- Node.js 18.0+
- 一个可用的模型 API Key（见安装指南）；或用
--demo无 key 冒烟
一键安装
bash
npm install -g @forgeax/cli安装后全局命令为 forgeax（包名是 scoped 的 @forgeax/cli，命令不是 npm i -g forgeax）。
开始使用
bash
# 进入项目目录
cd my-project
# 启动交互（TTY 下为 TUI）
forgeax
# 或一次性提问
forgeax -p "帮我优化这个函数的性能"
# 无 API key 冒烟
forgeax --demo -p "hi"下一步
深入了解
配置和扩展
获取帮助
反馈和支持
- 源码与问题跟踪：ForgeaX-Games/forgeax-cli
- Studio 产品站：forgeax.github.io
- npm：
@forgeax/cli - English docs：Overview (EN)