# snow-ai

> Agentic coding in your terminal

Latest version **0.9.10** (published 2026-10-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install snow-ai
pnpm add snow-ai
yarn add snow-ai
bun add snow-ai
```

Provides the command `snow`.

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types; large bundle; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.9.10 |
| Published | 2026-10-19 |
| First published | 2025-08-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=22 |
| Dependencies | 11 |
| Unpacked size | 43.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 1065 |
| Author | Mufasa |
| Maintainers | mufasa_embbot |
| Keywords | cli, ai, assistant, bot, terminal, ai coding, agentic, snow, snow cli |

## Links

- npm: https://www.npmjs.com/package/snow-ai
- Repository: https://github.com/MayDay-wpf/snow-cli
- Homepage: https://github.com/MayDay-wpf/snow-cli#readme
- Issues: https://github.com/MayDay-wpf/snow-cli/issues
- npm.io page: https://npm.io/package/snow-ai

## Dependencies (11)

- [ws](https://npm.io/package/ws.md) ^8.14.2
- [ssh2](https://npm.io/package/ssh2.md) ^1.17.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.7.0
- [eventsource](https://npm.io/package/eventsource.md) ^2.0.2
- [fetch-cookie](https://npm.io/package/fetch-cookie.md) ^3.0.1
- [tough-cookie](https://npm.io/package/tough-cookie.md) ^6.0.0
- [@vscode/ripgrep](https://npm.io/package/@vscode/ripgrep.md) ^1.18.0
- [abort-controller](https://npm.io/package/abort-controller.md) ^3.0.0
- [@microsoft/signalr](https://npm.io/package/@microsoft/signalr.md) ^10.0.0
- [@modelcontextprotocol/node](https://npm.io/package/@modelcontextprotocol/node.md) ^2.0.0
- [@modelcontextprotocol/client](https://npm.io/package/@modelcontextprotocol/client.md) ^2.0.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.9.10 (latest) — 2026-10-19
- 0.9.9 — 2026-10-18
- 0.9.8 — 2026-10-16
- 0.9.7 — 2026-10-15
- 0.9.6 — 2026-10-14
- 0.9.5 — 2026-10-13
- 0.9.4 — 2026-10-12
- 0.9.3 — 2026-10-12
- 0.9.2 — 2026-10-09
- 0.9.1 — 2026-10-09
- 0.9.0 — 2026-10-08
- 0.8.38 — 2026-10-08
- 0.8.37 — 2026-10-02
- 0.8.36 — 2026-10-01
- 0.8.35 — 2026-09-20
- … 279 more at https://npm.io/package/snow-ai/versions

## README

<div align="center">

<img src="docs/images/logo.png" alt="Snow AI CLI Logo" width="200"/>

# snow-ai

[![npm version](https://img.shields.io/npm/v/snow-ai.svg)](https://www.npmjs.com/package/snow-ai)
[![npm downloads](https://img.shields.io/npm/dm/snow-ai.svg)](https://www.npmjs.com/package/snow-ai)
[![license](https://img.shields.io/npm/l/snow-ai.svg)](https://github.com/MayDay-wpf/snow-cli/blob/main/LICENSE)
[![node](https://img.shields.io/node/v/snow-ai.svg)](https://nodejs.org/)

<a href="https://www.producthunt.com/products/snow-cli/launches/snow-cli?embed=true&amp;utm_source=badge-featured&amp;utm_medium=badge&amp;utm_campaign=badge-snow-cli" target="_blank" rel="noopener noreferrer"><img alt="Snow CLI - Agentic coding in your terminal | Product Hunt" width="250" height="54" src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=1084735&amp;theme=light&amp;t=1776848197707"></a>

**English** | [中文](README_zh.md)

**QQ Group**: 910298558

**Telegram**: [https://t.me/snow_cli](https://t.me/snow_cli)

_Agentic coding in your terminal_

</div>

## Snow App

> **Snow App** is the desktop coding client for Snow CLI. Download it here: [https://github.com/MayDay-wpf/snow-app](https://github.com/MayDay-wpf/snow-app)

## Thanks Developer

<a href="https://github.com/MayDay-wpf/snow-cli/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=MayDay-wpf/snow-cli" />
</a>

## Sponsors

<table width="100%" align="center">
  <thead>
    <tr>
      <th width="50%">Sponsor</th>
      <th width="50%">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td align="center">
        <a href="https://www.packyapi.ai/"><img src="docs/images/packyapi.jpg" alt="PackyCode" width="360"/></a>
        <br/>
        <a href="https://www.packyapi.ai/"><b>PackyCode</b></a>
      </td>
      <td>Access leading AI models through PackyCode with one API endpoint and one API key. Enjoy fast, reliable access with automatic failover and dedicated high-speed routes for Codex and Claude Code.<br/>Get started with $1 in free credits, a discount on your first top-up, and savings of up to 80% on eligible routes. Pay in RMB with no currency conversion markups or extra top-up fees.<br/><a href="https://www.packyapi.ai/">Sign up through the link</a> and start building today.</td>
    </tr>
    <tr>
      <td align="center">
        <a href="https://go.apimart.ai/gh-snow-cli"><img src="docs/images/apimart.jpg" alt="APIMart" width="360"/></a>
        <br/>
        <a href="https://go.apimart.ai/gh-snow-cli"><b>APIMart</b></a>
      </td>
      <td>APIMart is a low-cost API platform for AI image & video generation — GPT-Image-2 from $0.006/image, 160+ images per dollar. One async API covers both image and video: submit a task, get an ID, fetch results via polling or callback. Batch tens of thousands of images without timeouts, switch models without changing code. Pay-as-you-go with no monthly fee — <a href="https://go.apimart.ai/gh-snow-cli">sign up here</a> to get started.</td>
    </tr>
    <tr>
      <td align="center">
        <a href="https://bloome.im/app?ref=MayDaywpf&utm_medium=github&utm_source=MayDay-wpf-snow-cli-ivor-202607"><img src="docs/images/bloome-home.png" alt="Bloome" width="360"/></a>
        <br/>
        ☁️ <a href="https://bloome.im/app?ref=MayDaywpf&utm_medium=github&utm_source=MayDay-wpf-snow-cli-ivor-202607"><b>Bloome</b></a>
      </td>
      <td>AI-agent IM platform — multiple AI agents (Claude, ChatGPT, DeepSeek…) collaborate in one shared chat: they hand off tasks, cross-check each other, and refine until it's right. Zero setup, runs in the cloud, shareable with your team. Try it 👉 <a href="https://bloome.im/app?ref=MayDaywpf&utm_medium=github&utm_source=MayDay-wpf-snow-cli-ivor-202607">Bloome</a></td>
    </tr>
    <tr>
      <td><a href="https://www.jetbrains.com/">JetBrains</a></td>
      <td>Open Source Project Sponsor, providing free IDE licenses</td>
    </tr>
  </tbody>
</table>

## Relay Station Recommendations

> The relay stations listed here are mutual recommendation partnerships, not commercial sponsorships. Any relay station that provides a Snow CLI usage tutorial and a test account for availability verification is welcome to join.

| Relay Station | Link                                                   |
| ------------- | ------------------------------------------------------ |
| ccapi         | [https://ccapi.ztxfkw.top/](https://ccapi.ztxfkw.top/) |

![alt text](docs/images/image.png)

![alt text](docs/images/image2.png)

<h3>Recommend using fonts: <a href="https://github.com/SpaceTimee/Fusion-JetBrainsMapleMono">JetBrains Maple Mono NF</a> </3>

<h3>Recommended Terminal Combination for Windows Users</h3>

- **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**:

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

# Or install using the Microsoft Store
```

## Installation

Install Snow CLI globally via npm:

```bash
npm install -g snow-ai
```

After installation, run:

```bash
snow
```

## Documentation

- [Installation Guide](docs/usage/en/01.Installation%20Guide.md) - System requirements, installation (update, uninstall) steps, IDE extension installation
- [First Time Configuration](docs/usage/en/02.First%20Time%20Configuration.md) - API configuration, model selection, basic settings
- [Startup Parameters Guide](docs/usage/en/19.Startup%20Parameters%20Guide.md) - Command-line parameters explained, quick start modes, headless mode, async tasks, developer mode

### Advanced Configuration

- [Proxy and Browser Settings](docs/usage/en/03.Proxy%20and%20Browser%20Settings.md) - Network proxy configuration, browser usage settings
- [Codebase Setup](docs/usage/en/04.Codebase%20Setup.md) - Codebase integration, search configuration
- [Sub-Agent Configuration](docs/usage/en/05.Sub-Agent%20Configuration.md) - Sub-agent management, custom agents, **project Markdown agents (#194)**
- [Sensitive Commands Configuration](docs/usage/en/06.Sensitive%20Commands%20Configuration.md) - Sensitive command protection, custom command rules
- [Hooks Configuration](docs/usage/en/07.Hooks%20Configuration.md) - Workflow automation, **additionalContext inject / beforeSubAgentStart / type:context (#194)**
- [Theme Settings](docs/usage/en/08.Theme%20Settings.md) - Interface theme configuration, custom color schemes, simplified mode
- [Third-Party Relay Configuration](docs/usage/en/16.Third-Party%20Relay%20Configuration.md) - Claude Code relay, Codex relay, custom headers configuration

### Feature Guide

- [Command Panel Guide](docs/usage/en/09.0.Command%20Panel%20Guide.md) - Detailed description of all available commands, usage tips, shortcut key reference (split into 09.1~09.7 sub-documents by category)
- [Command Injection Mode](docs/usage/en/10.Command%20Injection%20Mode.md) - Execute commands directly in messages, syntax explanation, security mechanisms, use cases
- [Vulnerability Hunting Mode](docs/usage/en/11.Vulnerability%20Hunting%20Mode.md) - Professional security analysis, vulnerability detection, verification scripts, detailed reports
- [Headless Mode](docs/usage/en/12.Headless%20Mode.md) - Command line quick conversations, session management, script integration, third-party tool integration
- [Keyboard Shortcuts Guide](docs/usage/en/13.Keyboard%20Shortcuts%20Guide.md) - All keyboard shortcuts, editing operations, navigation control, rollback functionality
- [MCP Configuration](docs/usage/en/14.MCP%20Configuration.md) - MCP service management, configure external services, enable/disable services, troubleshooting
- [Async Task Management](docs/usage/en/15.Async%20Task%20Management.md) - Background task creation, task management interface, sensitive command approval, task to session conversion
- [Skills Command Detailed Guide](docs/usage/en/18.Skills%20Command%20Detailed%20Guide.md) - Skill creation, usage methods, Claude Code Skills compatibility, tool restrictions
- [LSP Configuration and Usage](docs/usage/en/17.LSP%20Configuration.md) - LSP config file, language server installation, ACE tool usage (definition/outline)
- [SSE Service Mode](docs/usage/en/20.SSE%20Service%20Mode.md) - SSE server startup, API endpoints explanation, tool confirmation flow, permission configuration, YOLO mode, client integration examples
- [Custom StatusLine Guide](docs/usage/en/21.Custom%20StatusLine%20Guide.md) - User-level StatusLine plugins, hook structure, override behavior, bilingual examples
- [Team Mode Guide](docs/usage/en/22.Team%20Mode%20Guide.md) - Multi-agent collaboration, parallel task execution, team management
- [Custom Search Engine Guide](docs/usage/en/23.Custom%20Search%20Engine%20Guide.md) - User-level search engine plugins, engine contract, enable flag, minimal template
- [Privacy Settings Guide](docs/usage/en/24.Privacy%20Settings%20Guide.md) - Local privacy filter API deployment, Snow CLI privacy configuration, tool result redaction, and troubleshooting
- [Buddy Companion Guide](docs/usage/en/25.Buddy%20Companion%20Guide.md) - Terminal buddy companion commands, hatching, species selection, interaction, mute, and reset

### Recommended ROLE.md

- [Recommended ROLE.md](docs/role/en/01.Snow%20CLI%20Plan%20Every%20Step.md) - Recommended behavior guidelines, work mode, and quality standards for the Snow CLI terminal programming assistant
  - Bilingual documentation: English (primary) / [Chinese](docs/role/zh/01.Snow%20CLI%20一步一规划.md)
  - 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:

```bash
node --version
```

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

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

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

### Build from Source

```bash
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](https://marketplace.visualstudio.com/items?itemName=mufasa.snow-cli)

#### JetBrains Plugin

- Plugin source located in `Jetbrains/` directory
- Download release: [JetBrains plugin](https://plugins.jetbrains.com/plugin/28715-snow-cli/edit)

### 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
├── settings.json           # Unified settings (includes mcpServers)
└── ...                     # Other config files
```

## Friendly links

- [Linux DO](https://linux.do)

## Star History

[![Star History Chart](https://star-history.dera.page/svg?repos=MayDay-wpf/snow-cli&type=Date)](https://star-history.dera.page/#MayDay-wpf/snow-cli&Date)

---
_Source: https://npm.io/package/snow-ai · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._