snow-ai

English | 中文

QQ Group: 910298558

Telegram: https://t.me/snow_cli

AI Community: https://linux.do

Agentic coding in your terminal

Thanks Developer

Sponsors

Sponsor	Description
acker798.xyz	AI Relay Station, supports Codex
JetBrains	Open Source Project Sponsor, providing free IDE licenses

Recommend using fonts: JetBrains Maple Mono NF

Recommended Terminal Combination for Windows Users

• PowerShell 7+: Modern cross-platform PowerShell, offering stronger features and better compatibility
  • GitHub: https://github.com/PowerShell/PowerShell
• Windows Terminal: Modern terminal application, supporting multi-tab, split-screen, and GPU accelerated rendering
  • GitHub: https://github.com/microsoft/terminal

Installation:

# Install using winget (built-in for Windows 10/11)
winget install Microsoft.PowerShell
winget install Microsoft.WindowsTerminal

# Or install using the Microsoft Store

Documentation

• 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

Advanced Configuration

• 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

Feature Guide

• Command Panel Guide - Detailed description of all available commands, usage tips, shortcut key reference (split into 09.1~09.7 sub-documents by category)
• 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
• Custom StatusLine Guide - User-level StatusLine plugins, hook structure, override behavior, bilingual examples
• Team Mode Guide - Multi-agent collaboration, parallel task execution, team management
• Custom Search Engine Guide - User-level search engine plugins, engine contract, enable flag, minimal template

Recommended ROLE.md

• 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

---

Development Guide

Prerequisites

• Node.js >= 18.x (Requires ES2020 features support)
• npm >= 8.3.0

Check your Node.js version:

node --version

If your version is below 18.x, please upgrade first:

# Using nvm (recommended)
nvm install 18
nvm use 18

# Or download from official website
# https://nodejs.org/

Build from Source

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

IDE Extension Development

VSCode Extension

• Extension source located in VSIX/ directory
• Download release: mufasa.snow-cli

JetBrains Plugin

• Plugin source located in Jetbrains/ directory
• Download release: JetBrains plugin

Project Structure

source/                     # Source code
├── agents/                 # AI agents implementation
├── api/                    # LLM API adapters
├── hooks/                  # React hooks for conversation
├── i18n/                   # Internationalization
├── mcp/                    # Model Context Protocol
├── prompt/                 # System prompt templates
├── types/                  # TypeScript type definitions
├── ui/                     # UI components (Ink)
└── utils/                  # Utility functions

bundle/                     # Build output (single-file executable)
dist/                       # TypeScript compilation output
docs/                       # Documentation
JetBrains/                  # JetBrains plugin source
scripts/                    # Build and utility scripts
VSIX/                       # VSCode extension source

User Configuration Directory

After running snow, .snow/ directory is created in your home folder:

~/.snow/                    # User configuration directory
├── log/                    # Runtime logs (local, can be deleted)
├── profiles/               # Configuration profiles
├── sessions/               # Conversation history
├── tasks/                  # Async tasks
├── hooks/                  # Workflow hooks
├── config.json             # API configuration
├── mcp-config.json         # MCP configuration
└── ...                     # Other config files

Star History