Skip to content

README_zh.md

Latest commit

 

History

History
202 lines (148 loc) · 8.19 KB

README_zh.md

File metadata and controls

202 lines (148 loc) · 8.19 KB
Snow AI CLI Logo

snow-ai

npm version npm downloads license node

Snow CLI - Agentic coding in your terminal | Product Hunt

English | 中文

QQ 群: 910298558

Telegram: https://t.me/snow_cli

AI 社区: https://linux.do

在终端中进行 Agentic 编程

感谢开发者

赞助商

赞助商 介绍
acker798.xyz AI 中转站，支持 Codex
JetBrains 开源项目赞助者，提供全套 IDE 免费许可证

alt text

alt text

推荐使用字体：JetBrains Maple Mono NF

Windows 用户推荐终端组合

安装方式:

# 使用 winget 安装 (Windows 10/11 自带)
winget install Microsoft.PowerShell
winget install Microsoft.WindowsTerminal

# 或使用 Microsoft Store 安装

文档目录

  • 安装指南 - 系统要求、安装(更新、卸载)步骤、IDE 扩展安装
  • 首次配置 - API 配置、模型选择、基础设置
  • 启动参数说明 - 命令行参数详解、快速启动模式、无头模式、异步任务、开发者模式

高级配置

功能指南

  • 指令面板说明 - 所有可用指令的详细说明、使用技巧、快捷键参考（按类目拆分为 09.1~09.7 子文档）
  • 命令注入模式 - 消息中直接执行命令、语法说明、安全机制、使用场景
  • 漏洞猎人模式 - 专业安全分析、漏洞检测、验证脚本、详细报告
  • 无头模式 - 命令行快速对话、会话管理、脚本集成、第三方工具集成
  • 快捷键指南 - 所有快捷键说明、编辑操作、导航控制、回滚功能
  • MCP 配置 - MCP 服务管理、配置外部服务、启用/禁用服务、故障排除
  • 异步任务管理 - 后台任务创建、任务管理界面、敏感命令审批、任务转会话
  • Skills 指令详细说明 - 技能创建、使用方法、Claude Code Skills 兼容性、工具限制
  • LSP 配置与用法 - LSP 配置文件、语言服务器安装、ACE 工具用法(跳转/大纲)
  • SSE 服务模式 - SSE 服务器启动、API 端点说明、工具确认流程、权限配置、YOLO 模式、客户端集成示例
  • 自定义 StatusLine 指南 - 用户级状态栏插件、hook 结构、覆盖机制、中英文示例
  • Team 模式指南 - 多智能体协作、并行任务执行、团队管理
  • 自定义搜索引擎指南 - 用户级搜索引擎插件、引擎合约、enable 开关、最小模板示例

推荐使用的 ROLE.md

  • 推荐使用的 ROLE.md - Snow CLI 终端编程助手推荐使用的行为准则、工作模式与质量标准
    • 双语文档：中文（主版本）/英文
    • 维护规则：保持中英文结构对齐，工具名称保持不变

开发指南

环境要求

  • Node.js >= 18.x (需要 ES2020 特性支持)
  • npm >= 8.3.0

检查你的 Node.js 版本：

node --version

如果版本低于 18.x，请先升级：

# 使用 nvm (推荐)
nvm install 18
nvm use 18

# 或从官网下载
# https://nodejs.org/

源码构建

git clone https://github.com/MayDay-wpf/snow-cli.git
cd snow-cli
npm install
npm run link   # 构建并全局链接 snow
# 之后删除链接: npm run unlink

IDE 扩展开发

VSCode 扩展

JetBrains 插件

项目结构

source/                     # 源代码
├── agents/                 # AI 代理实现
├── api/                    # LLM API 适配器
├── hooks/                  # 对话 React Hooks
├── i18n/                   # 国际化
├── mcp/                    # Model Context Protocol
├── prompt/                 # 系统提示词模板
├── types/                  # TypeScript 类型定义
├── ui/                     # UI 组件 (Ink)
└── utils/                  # 工具函数

bundle/                     # 构建输出（单文件可执行）
dist/                       # TypeScript 编译输出
docs/                       # 文档
JetBrains/                  # JetBrains 插件源码
scripts/                    # 构建和工具脚本
VSIX/                       # VSCode 扩展源码

用户配置目录

运行 snow 后，会在主目录创建 .snow/ 文件夹：

~/.snow/                    # 用户配置目录
├── log/                    # 运行日志(本地，可删除)
├── profiles/               # 配置文件
├── sessions/               # 对话记录
├── tasks/                  # 异步任务
├── hooks/                  # 工作流钩子
├── config.json             # API 配置
├── mcp-config.json         # MCP 配置
└── ...                     # 其他配置文件

Star History

Star History Chart