You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage/en/01.Installation Guide.md
+41-25Lines changed: 41 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,59 +24,75 @@ Welcome to Snow CLI! Agentic coding in your terminal.
24
24
25
25
3. Linux: Install Node.js+npm via apt-get
26
26
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
+
```
31
31
32
32
4. Verify successful installation
33
33
34
-
```bash
35
-
node -v
36
-
npm -v
37
-
```
34
+
```bash
35
+
node -v
36
+
npm -v
37
+
```
38
38
39
39
### 3. Installing Snow CLI and IDE Plugins
40
40
41
41
1. Install Snow CLI using npm
42
42
43
-
```bash
44
-
npm install -g snow-ai
45
-
```
43
+
```bash
44
+
npm install -g snow-ai
45
+
```
46
46
47
47
2. Install Snow CLI by compiling from source
48
48
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
+
```
56
56
57
57
3. Verify successful installation
58
58
59
-
```bash
60
-
snow --version
61
-
snow --help
62
-
```
59
+
```bash
60
+
snow --version
61
+
snow --help
62
+
```
63
63
64
64
4. Install VSCode Plugin
65
65
66
66
Search for `Snow CLI` in the Extensions Marketplace and install
67
67
68
68

69
69
After installation, a launch icon will appear in the top-right corner of VSCode
70
-
70
+
71
71

72
72
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
+
73
89
6. Install JetBrains IDE Plugin
74
90
75
91
Search for `Snow CLI` in the Plugin Marketplace and install
76
92
77
93
After plugin installation, restart your IDE
78
94

79
-
95
+
80
96
A launch icon will appear to the right of the `Tab` in the terminal
0 commit comments