@mk-co/neox-cli
v2.0.9
Published
Professional AI code assistant CLI powered by Node.js
Readme
Features
| 功能 | 说明 | 状态 | |------|------|------| | 多模型支持 | Claude / GPT / 豆包 / 自定义 API | ✅ | | 双形态 | CLI 终端 + Electron 桌面应用 | ✅ | | Shadow Git | 消息级自动快照,支持多级回滚 | ✅ | | 内置编辑器 | Monaco Editor (VS Code 同款) | ✅ | | 内置终端 | 多终端会话管理 | ✅ | | Timeline | 可视化操作时间线 | ✅ | | Java Debug | 基于 DAP 协议的调试集成 | ✅ | | Python Debug | Python 调试支持 | 🚧 | | 浏览器自动化 | Puppeteer 集成 | 🚧 | | 插件系统 | 第三方工具扩展 | 📋 | | 多 Agent 协作 | 多角色 Agent 并行工作 | 📋 |
✅ 已完成 · 🚧 开发中 · 📋 计划中
Quick Start
CLI
# 安装(默认:轻量版,无需编译)
npm install -g @mk-co/neox-cli
# 启动
neox需要 Electron UI? 参见 Windows 安装指南
Desktop
从 Releases 下载对应平台安装包。
macOS 首次打开如遇安全提示:
sudo xattr -r -d com.apple.quarantine /Applications/Neox.appFrom Source
git clone https://github.com/mk-co/Neox.git
cd Neox && npm install
# CLI
npm run dev
# Desktop
npm run ui:devConfiguration
首次启动会引导配置,配置文件位置:
| 平台 | 路径 |
|------|------|
| macOS | ~/Library/Application Support/Neox/config.json |
| Linux | ~/.config/neox/config.json |
| Windows | %APPDATA%\Neox\config.json |
配置示例:
{
"providers": [
{
"id": "openai",
"type": "openai",
"baseUrl": "https://api.openai.com/v1",
"apiKey": "sk-...",
"models": ["gpt-4o"]
}
]
}CLI Commands
# 会话
/sessions # 列出会话
/session new # 新建会话
/clear # 清空当前会话
# 回滚
/checkpoint [name] # 创建检查点
/rollback # 打开快照选择器
/undo # 撤销上一步
# 模型
/provider list # 查看 Provider
/model # 切换模型
/health # 健康检查Java Debug
# 安装调试组件
npm run setup-java-debug
# 启动 Java 应用 (开启调试)
java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -jar app.jar然后在 Neox 中连接 localhost:5005 即可让 AI 进行断点调试。
Tech Stack
- Runtime: Node.js 20+
- Desktop: Electron 32
- Editor: Monaco Editor
- Terminal: xterm.js + node-pty
- AI SDK: OpenAI API / Anthropic API
Contributing
# Fork & Clone
git checkout -b feature/xxx
# 提交
git commit -m "feat: xxx"
# PR