Skip to content

Commit 338535c

Browse files
author
echoVic
committed
docs: 更新用户文档和配置指南
- 重构 README.md 结构,突出核心特性和 80+ Provider 支持 - 更新 config-system.md 添加模型配置向导和详细 Provider 说明 - 简化 quick-start.md 内容,优化新手入门体验 - 统一文档风格,移除冗余信息,增强可读性
1 parent 2dd1f1a commit 338535c

3 files changed

Lines changed: 372 additions & 231 deletions

File tree

docs/README.md

Lines changed: 101 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,132 @@
1-
# 🗡️ Blade Code 用户文档
1+
# Blade
22

3-
欢迎使用 Blade Code!这是一款基于 React + Ink 构建的新一代 AI 编程助手命令行工具,支持智能对话、工具调用、多模型切换、权限管理等功能
3+
**Blade** 是一个强大的终端 AI 编程助手,帮助你在命令行中高效完成编码任务
44

5-
## 核心特性
5+
## 核心特性
66

7-
- 🤖 **智能对话** - 基于大语言模型,支持上下文理解和多轮对话
8-
- 🆓 **开箱即用** - 内置免费 GLM-4.7 模型(支持思维链推理),无需配置即可体验
9-
- 🛠️ **丰富工具** - 内置 20+ 工具:文件读写、代码搜索、Shell 执行、Git 操作、网络请求等
10-
- 🔗 **MCP 协议** - 支持 Model Context Protocol,轻松扩展外部工具
11-
- 🌐 **智能搜索** - WebSearch 支持多提供商(Exa → DuckDuckGo → SearXNG)自动故障转移
12-
- 🎨 **现代 UI** - 基于 React + Ink,支持 Markdown 渲染和语法高亮
13-
- 💾 **会话管理** - 多会话、继续对话、会话恢复、会话 Fork
14-
- 🔒 **安全可控** - 五级权限模式(default/autoEdit/plan/yolo/spec)、工具白名单、操作确认
15-
- 📋 **Spec 模式** - 规格驱动开发,结构化工作流
16-
- 🧠 **Subagents** - 可定制的子代理系统,支持任务分发
17-
-**Skills 系统** - 动态 Prompt 扩展机制
7+
### 🚀 零配置启动
188

19-
## 🚀 快速开始
9+
内置免费 GLM-4.7 模型,安装即用,无需任何配置。
2010

21-
```bash
22-
# 零安装试用(内置免费模型,无需配置)
23-
npx blade-code
11+
### 📡 80+ Provider 支持
12+
13+
集成 [models.dev](https://models.dev) API,支持 80+ LLM Provider:
14+
15+
| 分类 | Provider |
16+
|------|----------|
17+
| **热门** | Anthropic, OpenAI, DeepSeek, Google, Groq, OpenRouter |
18+
| **云服务** | Azure, AWS Bedrock, Google Vertex, Cloudflare |
19+
| **开源友好** | Together AI, Fireworks, Cerebras, Novita AI |
20+
| **本地部署** | Ollama, LM Studio |
21+
22+
3 步配置向导:选择 Provider → 输入 API Key → 选择模型
23+
24+
### 🛡️ 安全权限控制
25+
26+
- 敏感操作前请求确认
27+
- 支持 glob 模式的权限规则
28+
- 多级权限模式(default、autoEdit、plan、yolo)
29+
30+
### 🔧 强大的工具集
31+
32+
- **文件操作**: 读取、写入、编辑、搜索
33+
- **代码分析**: 语法检查、类型检查、测试运行
34+
- **终端执行**: 安全的命令执行环境
35+
- **Git 集成**: 版本控制操作
36+
37+
### 📝 灵活的工作模式
38+
39+
- **Plan 模式**: 先规划后执行
40+
- **Spec 模式**: 结构化开发工作流
41+
- **Subagents**: 并行任务处理
2442

25-
# 全局安装
43+
### 🔌 MCP 扩展
44+
45+
支持 Model Context Protocol,可连接外部工具和服务。
46+
47+
## 快速开始
48+
49+
```bash
50+
# 安装
2651
npm install -g blade-code
2752

28-
# 启动交互式界面
53+
# 启动(内置免费模型,无需配置)
2954
blade
3055

31-
# 带首条消息启动
32-
blade "帮我分析这个项目"
56+
# 添加自定义模型(80+ Provider 可选)
57+
# 在 Blade 中输入: /model add
3358
```
3459

35-
> 首次运行会自动使用内置免费模型 GLM-4.7,也可通过模型配置向导添加自己的 API 密钥。
36-
37-
## 📚 文档导航
60+
## 文档目录
3861

3962
### 入门指南
4063

41-
- **[安装指南](getting-started/installation.md)** - 详细的安装步骤和环境要求
42-
- **[快速开始](getting-started/quick-start.md)** - 5 分钟快速上手
64+
- [安装说明](getting-started/installation.md)
65+
- [快速开始](getting-started/quick-start.md)
4366

4467
### 配置
4568

46-
- **[配置系统](configuration/config-system.md)** - 双文件配置体系完整指南
47-
- **[权限控制](configuration/permissions.md)** - 四级权限模式详解
48-
- **[主题配置](configuration/themes.md)** - 主题配置和自定义
69+
- [配置系统](configuration/config-system.md) - 80+ Provider 配置
70+
- [权限控制](configuration/permissions.md)
71+
- [主题配置](configuration/themes.md)
4972

5073
### 使用指南
5174

52-
- **[Slash 命令](guides/slash-commands.md)** - 内置和自定义命令
53-
- **[Subagents 系统](guides/subagents.md)** - 子代理配置与使用
54-
- **[Plan 模式](guides/plan-mode.md)** - 只读调研与方案规划
55-
- **[Spec 模式](guides/spec-mode.md)** - 规格驱动开发工作流
56-
- **[@ 文件提及](guides/at-file-mentions.md)** - 快速引用项目文件
57-
- **[Skills 系统](guides/skills.md)** - 动态 Prompt 扩展
58-
- **[Hooks 系统](guides/hooks.md)** - 工具执行钩子
75+
- [@ 文件引用](guides/at-file-mentions.md)
76+
- [Slash 命令](guides/slash-commands.md)
77+
- [Plan 模式](guides/plan-mode.md)
78+
- [Spec 模式](guides/spec-mode.md)
79+
- [Subagents](guides/subagents.md)
80+
- [Hooks](guides/hooks.md)
81+
- [Skills](guides/skills.md)
82+
- [Markdown 支持](guides/markdown-support.md)
5983

6084
### 参考
6185

62-
- **[CLI 命令](reference/cli-commands.md)** - 命令行参数参考
63-
- **[工具列表](reference/tool-list.md)** - 所有可用工具
86+
- [CLI 命令](reference/cli-commands.md)
87+
- [工具列表](reference/tool-list.md)
6488

6589
### 其他
6690

67-
- **[常见问题](faq.md)** - FAQ
68-
- **[更新日志](changelog.md)** - 版本历史
91+
- [更新日志](changelog.md)
92+
- [常见问题](faq.md)
93+
94+
## 支持的 Provider
95+
96+
Blade 通过 [models.dev](https://models.dev) 集成支持 80+ LLM Provider:
97+
98+
**热门 Provider**:
99+
- Anthropic (Claude)
100+
- OpenAI (GPT-4, o1)
101+
- DeepSeek (R1, V3)
102+
- Google (Gemini)
103+
- Groq (超快推理)
104+
- OpenRouter (多模型聚合)
105+
106+
**云服务**:
107+
- Azure OpenAI
108+
- AWS Bedrock
109+
- Google Vertex AI
110+
- Cloudflare Workers AI
111+
112+
**开源友好**:
113+
- Together AI
114+
- Fireworks AI
115+
- Cerebras
116+
- Novita AI
117+
- NVIDIA NIM
69118

70-
## 💬 交流群
119+
**本地部署**:
120+
- Ollama
121+
- LM Studio
71122

72-
- [Discord 社区](https://discord.gg/utXDVcv6) - 加入我们的 Discord 服务器
73-
- 微信群:添加小助手微信 **VIc-Forever**,备注「Blade」拉你进群
123+
**其他**:
124+
- Mistral AI
125+
- Cohere
126+
- Perplexity
127+
- xAI (Grok)
128+
- 更多...
74129

75-
## 🔗 相关资源
130+
## 许可证
76131

77-
- [官网](https://echovic.github.io/blade-code/#/)
78-
- [GitHub 仓库](https://github.com/echoVic/blade-code)
79-
- [NPM 包](https://www.npmjs.com/package/blade-code)
80-
- [问题反馈](https://github.com/echoVic/blade-doc/issues)
132+
MIT License

0 commit comments

Comments
 (0)