# 🗡️ Blade Code
**新一代 AI 编程助手（CLI + Web UI）**
[](https://www.npmjs.com/package/blade-code)
[](LICENSE)
[](https://nodejs.org/)
[](CONTRIBUTING.md)
[English](../../README.en.md) | 简体中文
---
## 📸 启动界面
---
## ✨ 核心特性
- 🤖 **智能对话** - 上下文理解、多轮协作、可继续会话
- 🆓 **开箱即用** - 内置免费 GLM-4.7 模型，可选自定义模型
- 🌐 **双模式界面** - CLI 终端 + Web UI，随心切换
- 🛠️ **丰富工具** - 20+ 内置工具：文件/搜索/Shell/Git/Web 等
- 🔗 **扩展能力** - MCP、插件与 Skills 系统
- 📋 **结构化工作流** - Spec / Plan / Subagents / Agent Teams
- 🔒 **安全可控** - default/autoEdit/plan/yolo 权限模式与工具白/黑名单
- 🎨 **现代 UI** - React + Ink 终端 UI / React + Vite Web UI
---
## 🚀 快速开始
```bash
# 快速体验
npx blade-code
# 全局安装
npm install -g blade-code
# 或
pnpm add -g blade-code
# CLI 模式
blade
blade "帮我分析这个项目"
blade --print "写一个快排算法"
# Web UI 模式（0.2.0 新增）
blade web # 启动并打开浏览器
blade serve --port 3000 # 无头服务器模式
```
> 默认使用内置免费模型；要使用自有模型，可运行 `blade` 按提示配置。
---
## ⚙️ 可选配置
配置文件支持全局和项目级：`~/.blade/config.json` 或 `.blade/config.json`。
更多配置项见文档。
```json
{
"currentModelId": "custom",
"modelProviders": {
"company-gateway": {
"name": "Company Gateway",
"baseUrl": "https://gateway.example.com/v1",
"wireApi": "openai-completions"
}
},
"models": [
{
"id": "custom",
"provider": "company-gateway",
"model": "gpt-4o-mini"
}
]
}
```
API key 以渠道 ID 为键存放在权限为 `0600` 的 `~/.blade/auth.json`，不会写入模型
或渠道配置。TUI 与 Web 均可创建 OpenAI Chat Completions 和 Anthropic Messages
兼容渠道。
---
## 🧰 命令速览
**常用命令**
- `blade` 启动交互式 CLI 界面
- `blade web` 启动 Web UI（0.2.0 新增）
- `blade serve` 启动无头服务器（0.2.0 新增）
- `blade mcp` 管理 MCP 服务器；`blade mcp login/logout` 显式管理远程 OAuth
- `blade doctor` 环境自检
- `blade update` 检查更新
**常用选项**
- `--print/-p` 打印模式（适合管道）
- `--output-format` 输出格式（text/json/stream-json）
- `--permission-mode` 权限模式
- `--resume/-r` 恢复会话；`--fork-session` 可复制历史到独立子会话
---
## 📖 文档
- **[用户文档](https://echovic.github.io/blade-doc/#/)**
- **[本仓库文档入口](../../docs/README.md)**
- **[贡献指南](../../CONTRIBUTING.md)**
---
## 🤝 贡献
```bash
git clone https://github.com/echoVic/blade-code.git
cd blade-code && bun install && bun run dev
```
---
## 💬 交流群
添加小助手微信 **VIc-Forever**，备注「Blade」拉你进群。
---
## 🔗 相关资源
- [NPM 包](https://www.npmjs.com/package/blade-code)
- [Discord 社区](https://discord.gg/utXDVcv6) - 加入我们的 Discord 服务器
- [问题反馈](https://github.com/echoVic/blade-code/issues)
---
## ⭐ Star History
---
## 📄 许可证
[MIT](../../LICENSE) - Made with ❤️ by [echoVic](https://github.com/echoVic)
