Skip to content

Commit 9e0122b

Browse files
committed
docs(usage): Update the installation guide document and add VSCode extension setup instructions
1 parent 25bbf28 commit 9e0122b

2 files changed

Lines changed: 89 additions & 57 deletions

File tree

docs/usage/en/01.Installation Guide.md

Lines changed: 41 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -24,59 +24,75 @@ Welcome to Snow CLI! Agentic coding in your terminal.
2424

2525
3. Linux: Install Node.js+npm via apt-get
2626

27-
```bash
28-
sudo apt-get install nodejs
29-
sudo apt-get install npm
30-
```
27+
```bash
28+
sudo apt-get install nodejs
29+
sudo apt-get install npm
30+
```
3131

3232
4. Verify successful installation
3333

34-
```bash
35-
node -v
36-
npm -v
37-
```
34+
```bash
35+
node -v
36+
npm -v
37+
```
3838

3939
### 3. Installing Snow CLI and IDE Plugins
4040

4141
1. Install Snow CLI using npm
4242

43-
```bash
44-
npm install -g snow-ai
45-
```
43+
```bash
44+
npm install -g snow-ai
45+
```
4646

4747
2. Install Snow CLI by compiling from source
4848

49-
```bash
50-
git clone https://github.com/MayDay-wpf/snow-cli
51-
cd snow-cli
52-
npm install
53-
npm run build
54-
npm run link
55-
```
49+
```bash
50+
git clone https://github.com/MayDay-wpf/snow-cli
51+
cd snow-cli
52+
npm install
53+
npm run build
54+
npm run link
55+
```
5656

5757
3. Verify successful installation
5858

59-
```bash
60-
snow --version
61-
snow --help
62-
```
59+
```bash
60+
snow --version
61+
snow --help
62+
```
6363

6464
4. Install VSCode Plugin
6565

6666
Search for `Snow CLI` in the Extensions Marketplace and install
6767

6868
![alt text](../images/image.png)
6969
After installation, a launch icon will appear in the top-right corner of VSCode
70-
70+
7171
![alt text](../images/image1.png)
7272

73+
5. VSCode Extension Settings
74+
75+
After installing the VSCode plugin, you can configure the following settings in `Settings` (search for `Snow CLI`):
76+
77+
- **Terminal Mode** (`snow-cli.terminalMode`): Choose the terminal display mode.
78+
- `split` (default): Opens a terminal in a right-side editor split.
79+
- `sidebar`: Embeds a terminal in the sidebar panel.
80+
- **Startup Command** (`snow-cli.startupCommand`): The command to run when the terminal starts. Default is `snow`. Supports comma-separated commands for round-robin assignment across multiple terminals.
81+
- **Shell Type** (`snow-cli.terminal.shellType`): Shell for the sidebar terminal. Default is `auto` to follow VS Code's default terminal profile. You can also specify a custom shell path (e.g., `C:\Program Files\Git\bin\bash.exe`, `/usr/bin/zsh`).
82+
- **Proxy URL** (`snow-cli.terminal.proxyUrl`): Optional proxy URL injected into Snow CLI terminals as `HTTP_PROXY`/`HTTPS_PROXY`. Leave empty to fall back to VS Code's `http.proxy` setting.
83+
- **Font Family** (`snow-cli.terminal.fontFamily`): Font family for the sidebar terminal. Leave empty to use the default monospace font.
84+
- **Font Size** (`snow-cli.terminal.fontSize`): Font size (px) for the sidebar terminal. Default is `14` (range: 8–32).
85+
- **Font Weight** (`snow-cli.terminal.fontWeight`): Font weight for the sidebar terminal. Default is `normal`.
86+
- **Line Height** (`snow-cli.terminal.lineHeight`): Line height for the sidebar terminal. Default is `1` (range: 0.8–2).
87+
- **Git Blame** (`snow-cli.gitBlame.enabled`): Enable Git Blame annotations on the current line, similar to GitLens. Default is `false`.
88+
7389
6. Install JetBrains IDE Plugin
7490

7591
Search for `Snow CLI` in the Plugin Marketplace and install
7692

7793
After plugin installation, restart your IDE
7894
![alt text](../images/image2.png)
79-
95+
8096
A launch icon will appear to the right of the `Tab` in the terminal
81-
97+
8298
![alt text](../images/image3.png)

docs/usage/zh/01.安装指南.md

Lines changed: 48 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
3. npm: >= 8.3.0
1414

15-
### 2、安装node.js + npm
15+
### 2、安装 node.js + npm
1616

1717
1. Windows: [https://nodejs.org/en/download/](https://nodejs.org/zh-cn/download/) 下载安装包安装 node.js+npm
1818

@@ -24,59 +24,75 @@
2424

2525
3. Linux: 通过 apt-get 安装 node.js+npm
2626

27-
```bash
28-
sudo apt-get install nodejs
29-
sudo apt-get install npm
30-
```
27+
```bash
28+
sudo apt-get install nodejs
29+
sudo apt-get install npm
30+
```
3131

3232
4. 验证安装成功
3333

34-
```bash
35-
node -v
36-
npm -v
37-
```
34+
```bash
35+
node -v
36+
npm -v
37+
```
3838

39-
### 3、安装Snow CLI 与 IDE插件
39+
### 3、安装 Snow CLI 与 IDE 插件
4040

41-
1. 使用npm安装Snow CLI
41+
1. 使用 npm 安装 Snow CLI
4242

43-
```bash
44-
npm install -g snow-ai
45-
```
43+
```bash
44+
npm install -g snow-ai
45+
```
4646

47-
2. 编译Snow CLI 源码安装
47+
2. 编译 Snow CLI 源码安装
4848

49-
```bash
50-
git clone https://github.com/MayDay-wpf/snow-cli
51-
cd snow-cli
52-
npm install
53-
npm run build
54-
npm run link
55-
```
49+
```bash
50+
git clone https://github.com/MayDay-wpf/snow-cli
51+
cd snow-cli
52+
npm install
53+
npm run build
54+
npm run link
55+
```
5656

5757
3. 验证安装成功
5858

59-
```bash
60-
snow --version
61-
snow --help
62-
```
59+
```bash
60+
snow --version
61+
snow --help
62+
```
6363

64-
4. 安装VSCode插件
64+
4. 安装 VSCode 插件
6565

6666
在扩展市场中搜索 `Snow CLI` 并安装
6767

6868
![alt text](../images/image.png)
69-
安装完成后在VSCode右上角会出现启动图标
70-
69+
安装完成后在 VSCode 右上角会出现启动图标
70+
7171
![alt text](../images/image1.png)
7272

73+
5. VSCode 扩展设置
74+
75+
安装 VSCode 插件后,可以在 `设置` 中搜索 `Snow CLI` 进行以下配置:
76+
77+
- **终端模式** (`snow-cli.terminalMode`):选择终端显示模式。
78+
- `split`(默认):在编辑器右侧分屏打开终端。
79+
- `sidebar`:在侧边栏面板中嵌入终端。
80+
- **启动命令** (`snow-cli.startupCommand`):终端启动时运行的命令。默认为 `snow`。支持逗号分隔的多个命令,按轮询顺序分配给多个终端。
81+
- **Shell 类型** (`snow-cli.terminal.shellType`):侧边栏终端使用的 Shell。默认为 `auto`,跟随 VS Code 默认终端配置。也可以指定自定义 Shell 路径(如 `C:\Program Files\Git\bin\bash.exe``/usr/bin/zsh`)。
82+
- **代理 URL** (`snow-cli.terminal.proxyUrl`):可选代理 URL,作为 `HTTP_PROXY`/`HTTPS_PROXY` 注入 Snow CLI 终端。留空则回退到 VS Code 的 `http.proxy` 设置。
83+
- **字体** (`snow-cli.terminal.fontFamily`):侧边栏终端字体。留空使用默认等宽字体。
84+
- **字号** (`snow-cli.terminal.fontSize`):侧边栏终端字号(px)。默认为 `14`(范围:8–32)。
85+
- **字重** (`snow-cli.terminal.fontWeight`):侧边栏终端字重。默认为 `normal`
86+
- **行高** (`snow-cli.terminal.lineHeight`):侧边栏终端行高。默认为 `1`(范围:0.8–2)。
87+
- **Git Blame** (`snow-cli.gitBlame.enabled`):启用 Git Blame 标注,在当前行显示提交信息(作者、时间、消息),类似 GitLens。默认为 `false`
88+
7389
6. 安装 Jetbrains IDE 插件
7490

7591
在插件市场中搜索 `Snow CLI` 并安装
7692

77-
插件安装成功后,重启IDE
93+
插件安装成功后,重启 IDE
7894
![alt text](../images/image2.png)
79-
95+
8096
在终端 `Tab` 右侧会有启动图标
81-
97+
8298
![alt text](../images/image3.png)

0 commit comments

Comments
 (0)