- Installation Guide - System requirements, installation (update, uninstall) steps, IDE extension installation
- First Time Configuration - API configuration, model selection, basic settings
- Startup Parameters Guide - Command-line parameters explained, quick start modes, headless mode, async tasks, developer mode
- Proxy and Browser Settings - Network proxy configuration, browser usage settings
- Codebase Setup - Codebase integration, search configuration
- Sub-Agent Configuration - Sub-agent management, custom sub-agent configuration
- Sensitive Commands Configuration - Sensitive command protection, custom command rules
- Hooks Configuration - Workflow automation, hook types explanation, practical configuration examples
- Theme Settings - Interface theme configuration, custom color schemes, simplified mode
- Third-Party Relay Configuration - Claude Code relay, Codex relay, custom headers configuration
- Command Panel Guide - Detailed description of all available commands, usage tips, shortcut key reference
- Command Injection Mode - Execute commands directly in messages, syntax explanation, security mechanisms, use cases
- Vulnerability Hunting Mode - Professional security analysis, vulnerability detection, verification scripts, detailed reports
- Headless Mode - Command line quick conversations, session management, script integration, third-party tool integration
- Keyboard Shortcuts Guide - All keyboard shortcuts, editing operations, navigation control, rollback functionality
- MCP Configuration - MCP service management, configure external services, enable/disable services, troubleshooting
- Async Task Management - Background task creation, task management interface, sensitive command approval, task to session conversion
- Skills Command Detailed Guide - Skill creation, usage methods, Claude Code Skills compatibility, tool restrictions
- LSP Configuration and Usage - LSP config file, language server installation, ACE tool usage (definition/outline)
- SSE Service Mode - SSE server startup, API endpoints explanation, tool confirmation flow, permission configuration, YOLO mode, client integration examples
- Recommended ROLE.md - Recommended behavior guidelines, work mode, and quality standards for the Snow CLI terminal programming assistant
- Bilingual documentation: English (primary) / Chinese
- Maintenance rule: Keep Chinese and English structures aligned; tool names remain unchanged
- Node.js >= 16.x (Requires ES2020 features support)
- npm >= 8.3.0
Check your Node.js version:
node --versionIf your version is below 16.x, please upgrade first:
# Using nvm (recommended)
nvm install 16
nvm use 16
# Or download from official website
# https://nodejs.org/git clone https://github.com/MayDay-wpf/snow-cli.git
cd snow-cli
npm install
npm run link # builds and globally links snow
# to remove the link later: npm run unlink- Extension source located in
VSIX/directory - Download release: mufasa.snow-cli
- Plugin source located in
Jetbrains/directory - Download release: JetBrains plugin
.snow/ # User configuration directory
├── log/ # Runtime logs (local, can be deleted)
├── profiles/ # Configuration profiles
├── sessions/ # Conversation history
├── snapshots/ # File snapshots
├── todos/ # TODO lists
├── tasks/ # Async tasks
├── task-logs/ # Async task logs
├── history/ # Command history
├── commands/ # Custom commands
├── hooks/ # Workflow hooks
├── sse-daemons/ # SSE daemon processes
├── sse-logs/ # SSE service logs
├── usage/ # Usage statistics
├── active-profile.json # Current active profile
├── config.json # API configuration
├── custom-headers.json # Custom request headers
├── mcp-config.json # MCP configuration
├── lsp-config.json # LSP configuration
├── proxy-config.json # Proxy settings
├── codebase.json # Codebase index settings
├── sub-agents.json # Sub-agent configuration
├── sensitive-commands.json # Sensitive command rules
├── theme.json # Theme settings
├── language.json # Language settings
├── history.json # History settings
└── system-prompt.json # Custom system prompts
