Skip to content

01.Installation Guide.md

Latest commit

 

History

History
98 lines (65 loc) · 3.22 KB

01.Installation Guide.md

File metadata and controls

98 lines (65 loc) · 3.22 KB

Snow CLI User Documentation - Installation Guide

Welcome to Snow CLI! Agentic coding in your terminal.

Installation Guide

1. System Requirements

  1. Operating System: Windows 10+ / macOS 10.15+ / Ubuntu 18.04+ / CentOS 7+

  2. Node.js: v18.0.0+

  3. npm: >= 8.3.0

2. Installing Node.js + npm

  1. Windows: Download and install Node.js+npm from https://nodejs.org/en/download/

  2. macOS: Install Node.js+npm via Homebrew

    brew install node

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

    sudo apt-get install nodejs
sudo apt-get install npm

  4. Verify successful installation

    node -v
npm -v

3. Installing Snow CLI and IDE Plugins

  1. Install Snow CLI using npm

    npm install -g snow-ai

  2. Install Snow CLI by compiling from source

    git clone https://github.com/MayDay-wpf/snow-cli
cd snow-cli
npm install
npm run build
npm run link

  3. Verify successful installation

    snow --version
snow --help

  4. Install VSCode Plugin

    Search for Snow CLI in the Extensions Marketplace and install

    alt text After installation, a launch icon will appear in the top-right corner of VSCode

    alt text

  5. VSCode Extension Settings

    After installing the VSCode plugin, you can configure the following settings in Settings (search for Snow CLI):

    • Terminal Mode (snow-cli.terminalMode): Choose the terminal display mode.
      • split (default): Opens a terminal in a right-side editor split.
      • sidebar: Embeds a terminal in the sidebar panel.
    • 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.
    • 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).
    • 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.
    • Font Family (snow-cli.terminal.fontFamily): Font family for the sidebar terminal. Leave empty to use the default monospace font.
    • Font Size (snow-cli.terminal.fontSize): Font size (px) for the sidebar terminal. Default is 14 (range: 8–32).
    • Font Weight (snow-cli.terminal.fontWeight): Font weight for the sidebar terminal. Default is normal.
    • Line Height (snow-cli.terminal.lineHeight): Line height for the sidebar terminal. Default is 1 (range: 0.8–2).
    • Git Blame (snow-cli.gitBlame.enabled): Enable Git Blame annotations on the current line, similar to GitLens. Default is false.

  6. Install JetBrains IDE Plugin

    Search for Snow CLI in the Plugin Marketplace and install

    After plugin installation, restart your IDE alt text

    A launch icon will appear to the right of the Tab in the terminal

    alt text