Skip to content

Commit f2b267c

Browse files
author
echoVic
committed
docs: 更新文档链接和README内容
- 在侧边栏和封面页添加官网链接 - 重新组织README结构,简化内容并更新核心特性描述 - 添加Discord社区链接和微信群信息 - 同步更新英文版README内容
1 parent 203140b commit f2b267c

5 files changed

Lines changed: 80 additions & 184 deletions

File tree

README.en.md

Lines changed: 36 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# 🗡️ Blade Code
44

5-
**Next-Generation AI-Powered Coding Assistant**
5+
**Next-Generation AI Coding Assistant (CLI)**
66

77
[![npm version](https://img.shields.io/npm/v/blade-code.svg?style=flat-square)](https://www.npmjs.com/package/blade-code)
88
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
@@ -17,131 +17,79 @@ English | [简体中文](README.md)
1717

1818
## ✨ Key Features
1919

20-
- 🤖 **Intelligent Conversations** - LLM-powered with context understanding and multi-turn dialogues
21-
- 🛠️ **Rich Toolset** - 18+ built-in tools: file operations, code search, shell execution, Git, and more
22-
- 🔗 **MCP Protocol** - Model Context Protocol support for seamless external tool integration
23-
- 🎨 **Modern UI** - React + Ink based terminal UI with Markdown rendering and syntax highlighting
24-
- 💾 **Session Management** - Multi-session, continuation, recovery, and forking support
25-
- 🔒 **Secure & Controllable** - Three-tier permission system (allow/ask/deny), tool whitelisting
20+
- 🤖 **Smart Chat** - Context-aware, multi-turn collaboration with session continuity
21+
- 🆓 **Out of the Box** - Built-in free GLM-4.7 model, plus custom models
22+
- 🛠️ **Rich Tooling** - 20+ built-in tools: file/search/shell/git/web and more
23+
- 🔗 **Extensible** - MCP, plugins, and Skills system
24+
- 📋 **Structured Workflows** - Spec / Plan / Subagents
25+
- 🔒 **Secure Control** - Permission modes: default/autoEdit/plan/yolo + allow/deny lists
26+
- 🎨 **Modern UI** - React + Ink TUI with Markdown and syntax highlighting
2627

2728
---
2829

2930
## 🚀 Quick Start
3031

31-
### Try Without Installation
32-
3332
```bash
3433
npx blade-code
35-
npx blade-code --print "Explain what TypeScript is"
36-
```
3734

38-
### Global Installation
39-
40-
```bash
4135
npm install -g blade-code
4236
# or
4337
pnpm add -g blade-code
44-
```
45-
46-
### Basic Usage
4738

48-
```bash
49-
blade # Interactive mode
50-
blade "Help me analyze this project" # Enter with initial message
51-
blade --print "Write a quicksort" # Print mode (for piping)
52-
blade --continue # Continue last conversation
39+
blade
40+
blade "Help me analyze this project"
41+
blade --print "Write a quicksort"
5342
```
5443

55-
> On first run, if no API key is configured, a setup wizard will appear automatically.
44+
> Uses the built-in free model by default; run `blade` to configure your own provider.
5645
5746
---
5847

59-
## 🔐 Configuration
48+
## ⚙️ Optional Configuration
6049

61-
### Config File
50+
Config supports global and project scope: `~/.blade/config.json` or `.blade/config.json`.
51+
See docs for the full schema.
6252

63-
```bash
64-
mkdir -p ~/.blade
65-
cat > ~/.blade/config.json << 'EOF'
53+
```json
6654
{
6755
"provider": "openai-compatible",
68-
"apiKey": "your-api-key",
56+
"apiKey": "${BLADE_API_KEY}",
6957
"baseUrl": "https://api.openai.com/v1",
70-
"model": "gpt-4"
58+
"model": "gpt-4o-mini"
7159
}
72-
EOF
7360
```
7461

75-
Supports environment variable interpolation: `"apiKey": "${BLADE_API_KEY}"`
76-
77-
### Get API Keys
78-
79-
- **Qwen**: [DashScope Console](https://dashscope.console.aliyun.com/apiKey)
80-
- **VolcEngine**: [Volcano Ark Console](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey)
81-
- **OpenAI**: [OpenAI Platform](https://platform.openai.com/api-keys)
82-
8362
---
8463

85-
## 💬 Usage Examples
64+
## 🧰 CLI At a Glance
8665

87-
```bash
88-
# Smart tool invocation
89-
blade "List all TypeScript files"
90-
blade "Find code containing TODO"
91-
blade "Review code in src/utils"
92-
93-
# Session management
94-
blade --session-id "my-project" "Start new project"
95-
blade --resume <id> # Resume session
96-
blade --resume <id> --fork-session # Fork session
97-
98-
# Security control
99-
blade --allowed-tools "Read,Grep" "Read-only operations"
100-
blade --permission-mode plan "Plan only, no execution"
101-
blade --yolo "Auto-approve all operations"
102-
```
66+
**Common Commands**
10367

104-
---
105-
106-
## 📚 Command Reference
107-
108-
### Main Commands
109-
110-
| Command | Description |
111-
|---------|-------------|
112-
| `blade` | Start interactive assistant |
113-
| `blade config` | Configuration management |
114-
| `blade mcp` | MCP server management |
115-
| `blade doctor` | System health check |
116-
| `blade update` | Check for updates |
117-
118-
### Common Options
119-
120-
| Option | Short | Description |
121-
|--------|-------|-------------|
122-
| `--print` | `-p` | Print response and exit |
123-
| `--continue` | `-c` | Continue recent session |
124-
| `--resume <id>` | `-r` | Resume specific session |
125-
| `--yolo` | | Auto-approve all operations |
68+
- `blade` start interactive UI
69+
- `blade mcp` manage MCP servers
70+
- `blade doctor` environment check
71+
- `blade update` check for updates
72+
- `blade install` install a specific version (experimental)
12673

127-
### Slash Commands
74+
**Common Options**
12875

129-
Use in interactive mode: `/init` `/help` `/clear` `/compact` `/context` `/agents` `/permissions` `/mcp` `/resume` `/theme` `/model`
76+
- `--print/-p` print mode (pipe-friendly)
77+
- `--output-format` output: text/json/stream-json
78+
- `--permission-mode` permission mode
79+
- `--resume/-r` resume session / `--session-id` set session
13080

13181
---
13282

13383
## 📖 Documentation
13484

135-
- **[User Docs](https://echovic.github.io/blade-doc/#/)** - Installation, configuration, usage guides
136-
- **[Developer Docs](docs/development/README.md)** - Architecture, implementation details
137-
- **[Contributing Guide](CONTRIBUTING.md)** - Open source contribution
85+
- **[User Docs](https://echovic.github.io/blade-doc/#/)**
86+
- **[Docs entry in repo](docs/README.md)**
87+
- **[Contributing Guide](CONTRIBUTING.md)**
13888

13989
---
14090

14191
## 🤝 Contributing
14292

143-
Contributions welcome! See [Contributing Guide](CONTRIBUTING.md).
144-
14593
```bash
14694
git clone https://github.com/echoVic/blade-code.git
14795
cd blade-code && pnpm install && pnpm dev
@@ -151,20 +99,15 @@ cd blade-code && pnpm install && pnpm dev
15199

152100
## 💬 Community
153101

154-
Add WeChat **VIc-Forever** with note "Blade" to join the group.
155-
156-
---
157-
158-
## 💬 Community
159-
160-
Add assistant on WeChat **VIc-Forever**, remark "Blade" to join the group.
102+
Add WeChat **VIc-Forever**, remark "Blade" to join the group.
161103

162104
---
163105

164106
## 🔗 Related Resources
165107

166108
- [NPM Package](https://www.npmjs.com/package/blade-code)
167-
- [Report Issues](https://github.com/echoVic/blade-doc/issues)
109+
- [Discord Community](https://discord.gg/utXDVcv6) - Join our Discord server
110+
- [Report Issues](https://github.com/echoVic/blade-code/issues)
168111

169112
---
170113

README.md

Lines changed: 35 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# 🗡️ Blade Code
44

5-
**新一代智能 AI 编程助手**
5+
**新一代 AI 编程助手(CLI)**
66

77
[![npm version](https://img.shields.io/npm/v/blade-code.svg?style=flat-square)](https://www.npmjs.com/package/blade-code)
88
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
@@ -17,131 +17,79 @@
1717

1818
## ✨ 核心特性
1919

20-
- 🤖 **智能对话** - 基于大语言模型,支持上下文理解和多轮对话
21-
- 🛠️ **丰富工具** - 内置 18+ 工具:文件读写、代码搜索、Shell 执行、Git 操作等
22-
- 🔗 **MCP 协议** - 支持 Model Context Protocol,轻松扩展外部工具
23-
- 🎨 **现代 UI** - 基于 React + Ink,支持 Markdown 渲染和语法高亮
24-
- 💾 **会话管理** - 多会话、继续对话、会话恢复、会话 Fork
25-
- 🔒 **安全可控** - 三级权限系统(allow/ask/deny)、工具白名单、操作确认
20+
- 🤖 **智能对话** - 上下文理解、多轮协作、可继续会话
21+
- 🆓 **开箱即用** - 内置免费 GLM-4.7 模型,可选自定义模型
22+
- 🛠️ **丰富工具** - 20+ 内置工具:文件/搜索/Shell/Git/Web 等
23+
- 🔗 **扩展能力** - MCP、插件与 Skills 系统
24+
- 📋 **结构化工作流** - Spec / Plan / Subagents
25+
- 🔒 **安全可控** - default/autoEdit/plan/yolo 权限模式与工具白/黑名单
26+
- 🎨 **现代 UI** - React + Ink 终端 UI,支持 Markdown 与高亮
2627

2728
---
2829

2930
## 🚀 快速开始
3031

31-
### 零安装试用
32-
3332
```bash
3433
npx blade-code
35-
npx blade-code --print "解释什么是 TypeScript"
36-
```
37-
38-
### 全局安装
3934

40-
```bash
4135
npm install -g blade-code
4236
#
4337
pnpm add -g blade-code
44-
```
4538

46-
### 基本使用
47-
48-
```bash
49-
blade # 交互式模式
50-
blade "帮我分析这个项目" # 带首条消息进入
51-
blade --print "写一个快排算法" # 打印模式(适合管道)
52-
blade --continue # 继续上次对话
39+
blade
40+
blade "帮我分析这个项目"
41+
blade --print "写一个快排算法"
5342
```
5443

55-
> 首次运行若未配置 API 密钥,会自动弹出设置向导
44+
> 默认使用内置免费模型;要使用自有模型,可运行 `blade` 按提示配置
5645
5746
---
5847

59-
## 🔐 配置
48+
## ⚙️ 可选配置
6049

61-
### 配置文件
50+
配置文件支持全局和项目级:`~/.blade/config.json``.blade/config.json`
51+
更多配置项见文档。
6252

63-
```bash
64-
mkdir -p ~/.blade
65-
cat > ~/.blade/config.json << 'EOF'
53+
```json
6654
{
6755
"provider": "openai-compatible",
68-
"apiKey": "your-api-key",
69-
"baseUrl": "https://dashscope.aliyuncs.com/compatible-mode/v1",
70-
"model": "qwen-max"
56+
"apiKey": "${BLADE_API_KEY}",
57+
"baseUrl": "https://api.openai.com/v1",
58+
"model": "gpt-4o-mini"
7159
}
72-
EOF
73-
```
74-
75-
支持环境变量插值:`"apiKey": "${BLADE_API_KEY}"`
76-
77-
### 获取 API 密钥
78-
79-
- **千问**: [DashScope 控制台](https://dashscope.console.aliyun.com/apiKey)
80-
- **火山引擎**: [火山方舟控制台](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey)
81-
- **OpenAI**: [OpenAI Platform](https://platform.openai.com/api-keys)
82-
83-
---
84-
85-
## 💬 使用示例
86-
87-
```bash
88-
# 智能工具调用
89-
blade "列出所有 TypeScript 文件"
90-
blade "查找包含 TODO 的代码"
91-
blade "审查 src/utils 目录的代码"
92-
93-
# 会话管理
94-
blade --session-id "my-project" "开始新项目"
95-
blade --resume <id> # 恢复会话
96-
blade --resume <id> --fork-session # Fork 会话
97-
98-
# 安全控制
99-
blade --allowed-tools "Read,Grep" "只读操作"
100-
blade --permission-mode plan "只规划不执行"
101-
blade --yolo "自动批准所有操作"
10260
```
10361

10462
---
10563

106-
## 📚 命令参考
107-
108-
### 主要命令
64+
## 🧰 命令速览
10965

110-
| 命令 | 说明 |
111-
|------|------|
112-
| `blade` | 启动交互式助手 |
113-
| `blade config` | 配置管理 |
114-
| `blade mcp` | MCP 服务器管理 |
115-
| `blade doctor` | 系统健康检查 |
116-
| `blade update` | 检查更新 |
66+
**常用命令**
11767

118-
### 常用选项
68+
- `blade` 启动交互式界面
69+
- `blade mcp` 管理 MCP 服务器
70+
- `blade doctor` 环境自检
71+
- `blade update` 检查更新
72+
- `blade install` 安装指定版本(实验)
11973

120-
| 选项 | 简写 | 说明 |
121-
|------|------|------|
122-
| `--print` | `-p` | 打印响应并退出 |
123-
| `--continue` | `-c` | 继续最近会话 |
124-
| `--resume <id>` | `-r` | 恢复指定会话 |
125-
| `--yolo` | | 自动批准所有操作 |
74+
**常用选项**
12675

127-
### Slash 命令
128-
129-
在交互模式中使用:`/init` `/help` `/clear` `/compact` `/context` `/agents` `/permissions` `/mcp` `/resume` `/theme` `/model`
76+
- `--print/-p` 打印模式(适合管道)
77+
- `--output-format` 输出格式(text/json/stream-json)
78+
- `--permission-mode` 权限模式
79+
- `--resume/-r` 恢复会话 / `--session-id` 指定会话
13080

13181
---
13282

13383
## 📖 文档
13484

135-
- **[用户文档](https://echovic.github.io/blade-doc/#/)** - 安装、配置、使用指南
136-
- **[开发者文档](docs/development/README.md)** - 架构设计、技术实现
137-
- **[贡献指南](CONTRIBUTING.md)** - 参与开源贡献
85+
- **[用户文档](https://echovic.github.io/blade-doc/#/)**
86+
- **[本仓库文档入口](docs/README.md)**
87+
- **[贡献指南](CONTRIBUTING.md)**
13888

13989
---
14090

14191
## 🤝 贡献
14292

143-
欢迎贡献!详见 [贡献指南](CONTRIBUTING.md)
144-
14593
```bash
14694
git clone https://github.com/echoVic/blade-code.git
14795
cd blade-code && pnpm install && pnpm dev
@@ -158,6 +106,7 @@ cd blade-code && pnpm install && pnpm dev
158106
## 🔗 相关资源
159107

160108
- [NPM 包](https://www.npmjs.com/package/blade-code)
109+
- [Discord 社区](https://discord.gg/utXDVcv6) - 加入我们的 Discord 服务器
161110
- [问题反馈](https://github.com/echoVic/blade-code/issues)
162111

163112
---

docs/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,14 @@ blade "帮我分析这个项目"
6868
- **[常见问题](faq.md)** - FAQ
6969
- **[更新日志](changelog.md)** - 版本历史
7070

71+
## 💬 交流群
72+
73+
- [Discord 社区](https://discord.gg/utXDVcv6) - 加入我们的 Discord 服务器
74+
- 微信群:添加小助手微信 **VIc-Forever**,备注「Blade」拉你进群
75+
7176
## 🔗 相关资源
7277

78+
- [官网](https://echovic.github.io/blade-code/#/)
7379
- [GitHub 仓库](https://github.com/echoVic/blade-code)
7480
- [NPM 包](https://www.npmjs.com/package/blade-code)
75-
- [问题反馈](https://github.com/echoVic/blade-code/issues)
76-
77-
## 💬 交流
78-
79-
添加小助手微信 **VIc-Forever**,备注「Blade」拉你进群。
81+
- [问题反馈](https://github.com/echoVic/blade-doc/issues)

0 commit comments

Comments
 (0)