snow-ai 0.6.5 → 0.6.7

package/README.md

@@ -4,6 +4,11 @@
 
 # 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/)
+
 **English** | [中文](README_zh.md)
 
 **QQ Group**: 910298558
@@ -12,42 +17,57 @@ _An intelligent AI-powered CLI tool for developers_
 
 </div>
 
-⚠️ Notice: If you want to use Snow to access domestic Claude Code or Codex relays, please [click here](#access-domestic-claude-code--codex-relay-snow-configuration) to see the corresponding configuration methods.
-
-## Thanks Developer 💖
+## Thanks Developer
 
 <img alt="contributors" src="https://contrib.rocks/image?repo=MayDay-wpf/snow-cli"/>
 
-## ❤️Thanks Support 💖
+## Thanks Support
+
+- [UUCode](https://www.uucode.org)
+
+---
+
+![alt text](docs/images/image.png)
 
-* [UUCode](https://www.uucode.org)
+## Documentation
 
-## << [Click to view the detailed complete document](docs/usage/en/0.Catalogue.md) >>
+- [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
 
-## Overview Catalog
+- [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 sub-agent configuration
+- [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, hook types explanation, practical configuration examples
+- [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
 
-- [System Requirements](#system-requirements)
-- [Installation](#installation)
-- [Access Domestic Claude Code & Codex Relay](#access-domestic-claude-code--codex-relay-snow-configuration)
-- [API & Model Settings](#api--model-settings)
-- [Proxy & Browser Settings](#proxy--browser-settings)
-- [System Prompt Settings](#system-prompt-settings)
-- [Custom Headers Settings](#custom-headers-settings)
-- [MCP Settings](#mcp-settings)
-- [Getting Started](#getting-started)
-- [Snow System Files](#snow-system-files)
+### Feature Guide
+
+- [Command Panel Guide](docs/usage/en/09.Command%20Panel%20Guide.md) - Detailed description of all available commands, usage tips, shortcut key reference
+- [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/19.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
 
 ---
 
-# System Requirements
+## Development Guide
 
-Prerequisites for installing Snow:
+### Prerequisites
 
 - **Node.js >= 16.x** (Requires ES2020 features support)
 - npm >= 8.3.0
 
-Check your Node.js version
+Check your Node.js version:
 
 ```bash
 node --version
@@ -64,17 +84,7 @@ nvm use 16
 # https://nodejs.org/
 ```
 
-# Installation
-
-## Install Snow CLI
-
-You can install directly using npm:
-
-```bash
-npm install -g snow-ai
-```
-
-Or visit: [Official Repository](https://github.com/MayDay-wpf/snow-cli) to build from source, quick clone command:
+### Build from Source
 
 ```bash
 git clone https://github.com/MayDay-wpf/snow-cli.git
@@ -84,250 +94,53 @@ npm run link   # builds and globally links snow
 # to remove the link later: npm run unlink
 ```
 
-## Install VSCode Extension
-
-- Download [snow-cli-x.x.x.vsix](https://github.com/MayDay-wpf/snow-cli/releases/tag/vsix)
-- Open VSCode, click `Extensions` → `Install from VSIX...` → select the downloaded file
-
-## Install JetBrains Plugin
-
-- Download [JetBrains plugin](https://github.com/MayDay-wpf/snow-cli/releases/tag/jetbrains)
-- Follow JetBrains plugin installation instructions
-
-## Available Commands
-
-* Start: `$ snow`
-* Update: `$ snow --update`
-* Version query: `$ snow --version`
-* Restore the latest conversation history: `$ snow -c`
-* Headless mode: `$ snow --ask "Hello"`
-* Default yolo: `$ snow --yolo`
-* Restore the most recent conversation and enable yolo: `$ snow --c-yolo`
-* Asynchronous task: `$ snow --task "Hello"`
-* Asynchronous task panel: `$ snow --task-list`
-
-# API & Model Settings
-
-For detailed configuration instructions, please refer to: [First Configuration Documentation](docs/usage/zh/02.首次配置.md)
-
-![API & Model Settings in CLI](docs/images/image.png)
+### IDE Extension Development
 
-# Proxy & Browser Settings
+#### VSCode Extension
 
-Configure system proxy port and search engine, usually no modifications needed.
+- Extension source located in `vscode-extension/` directory
+- Download release: [mufasa.snow-cli](https://marketplace.visualstudio.com/items?itemName=mufasa.snow-cli)
 
-![Proxy & Browser Settings in CLI](docs/images/image-1.png)
+#### JetBrains Plugin
 
-# System Prompt Settings
+- Plugin source located in `jetbrains-plugin/` directory
+- Download release: [JetBrains plugin](https://plugins.jetbrains.com/plugin/28715-snow-cli/edit)
 
-Customize system prompts to supplement Snow's built-in prompts.
-
-# Custom Headers Settings
-
-Add custom request headers, see [Relay Access Configuration](#access-domestic-claude-code--codex-relay-snow-configuration) for details.
-
-# MCP Settings
-
-Configure MCP services, JSON format compatible with Cursor.
-
-# Getting Started
-
-After startup, click **Start** to enter the conversation interface.
-
-![IDE Connected notification](docs/images/image-2.png)
-
-## Main Features
-
-- **File Selection**: Use `@` to select files
-- **Slash Commands**: Use `/` to view available commands
-- **Keyboard Shortcuts**:
-  - `Alt+V` (Windows) / `Ctrl+V` (macOS/Linux) - Paste image
-  - `Ctrl+L` / `Ctrl+R` - Clear input
-  - `Shift+Tab` - Toggle Yolo mode
-  - `ESC` - Stop generation
-  - Double-click `ESC` - Rollback conversation
-
-## Token Statistics
-
-Real-time Token usage is displayed below the input box.
-
-![Token usage diagram](docs/images/image-3.png)
-
-# Snow System Files
-
-All configuration files are located in the `.snow` folder in the user directory.
-
-![Configuration files overview](docs/images/image-4.png)
+### Project Structure
 
 ```
-.snow/
+.snow/                      # User configuration directory
 ├── log/                    # Runtime logs (local, can be deleted)
-├── profiles/               # Configuration files
+├── profiles/               # Configuration profiles
 ├── sessions/               # Conversation history
 ├── snapshots/              # File snapshots
-├── todo/                   # TODO lists
-├── active-profile.txt      # Current configuration
+├── 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
+├── ui-sessions/            # UI session data
+├── usage/                  # Usage statistics
+├── active-profile.json     # Current active profile
 ├── config.json             # API configuration
 ├── custom-headers.json     # Custom request headers
 ├── mcp-config.json         # MCP configuration
-└── system-prompt.txt       # Custom prompts
-```
-
-# Access Domestic Claude Code & Codex Relay (Snow Configuration)
-
-Relay service providers set up interception measures for third-party clients, so you need to configure custom system prompts and request headers in Snow to disguise access:
-
-## Claude Code
-
-Custom system prompt (**Note: No extra or missing characters allowed**), please enter the location shown below to copy and replace:
-
-```
-You are Claude Code, Anthropic's official CLI for Claude.
-```
-
-![Entry diagram 1](docs/images/image-5.png)
-
-In addition, you need to add the following custom request headers:
-
-```json
-{
-    "anthropic-beta": "claude-code-20250219,interleaved-thinking-2025-05-14",
-    "anthropic-dangerous-direct-browser-access":"true",
-    "anthropic-version": "2023-06-01",
-    "user-agent": "claude-cli/2.0.22 (external, cli",
-    "x-app": "cli"
-}
+├── 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
 ```
 
-**Enable 1M context request header:**
-
-```json
-{
-    "anthropic-beta": "claude-code-20250219,context-1m-2025-08-07,interleaved-thinking-2025-05-14",
-    "anthropic-dangerous-direct-browser-access":"true",
-    "anthropic-version": "2023-06-01",
-    "user-agent": "claude-cli/2.0.22 (external, cli",
-    "x-app": "cli"
-}
-```
-
-![Entry diagram 2](docs/images/image-6.png)
-
-## Codex
-
-Codex relay generally does not require header configuration. Similarly, please replace with the following custom system prompt (**Note: No extra or missing characters allowed**):
-
-```markdown
-You are Codex, based on GPT-5. You are running as a coding agent in the Codex CLI on a user's computer.
-
-## General
-
-- The arguments to `shell` will be passed to execvp(). Most terminal commands should be prefixed with ["bash", "-lc"].
-- Always set the `workdir` param when using the shell function. Do not use `cd` unless absolutely necessary.
-- When searching for text or files, prefer using `rg` or `rg --files` respectively because `rg` is much faster than alternatives like `grep`. (If the `rg` command is not found, then use alternatives.)
-
-## Editing constraints
-
-- Default to ASCII when editing or creating files. Only introduce non-ASCII or other Unicode characters when there is a clear justification and the file already uses them.
-- Add succinct code comments that explain what is going on if code is not self-explanatory. You should not add comments like "Assigns the value to the variable", but a brief comment might be useful ahead of a complex code block that the user would otherwise have to spend time parsing out. Usage of these comments should be rare.
-- Try to use apply_patch for single file edits, but it is fine to explore other options to make the edit if it does not work well. Do not use apply_patch for changes that are auto-generated (i.e. generating package.json or running a lint or format command like gofmt) or when scripting is more efficient (such as search and replacing a string across a codebase).
-- You may be in a dirty git worktree.
-  - NEVER revert existing changes you did not make unless explicitly requested, since these changes were made by the user.
-  - If asked to make a commit or code edits and there are unrelated changes to your work or changes that you didn't make in those files, don't revert those changes.
-  - If the changes are in files you've touched recently, you should read carefully and understand how you can work with the changes rather than reverting them.
-  - If the changes are in unrelated files, just ignore them and don't revert them.
-- While you are working, you might notice unexpected changes that you didn't make. If this happens, STOP IMMEDIATELY and ask the user how they would like to proceed.
-- **NEVER** use destructive commands like `git reset --hard` or `git checkout --` unless specifically requested or approved by the user.
-
-## Plan tool
-
-When using the planning tool:
-
-- Skip using the planning tool for straightforward tasks (roughly the easiest 25%).
-- Do not make single-step plans.
-- When you made a plan, update it after having performed one of the sub-tasks that you shared on the plan.
-
-## Codex CLI harness, sandboxing, and approvals
-
-The Codex CLI harness supports several different configurations for sandboxing and escalation approvals that the user can choose from.
-
-Filesystem sandboxing defines which files can be read or written. The options for `sandbox_mode` are:
-
-- **read-only**: The sandbox only permits reading files.
-- **workspace-write**: The sandbox permits reading files, and editing files in `cwd` and `writable_roots`. Editing files in other directories requires approval.
-- **danger-full-access**: No filesystem sandboxing - all commands are permitted.
-
-Network sandboxing defines whether network can be accessed without approval. Options for `network_access` are:
-
-- **restricted**: Requires approval
-- **enabled**: No approval needed
-
-Approvals are your mechanism to get user consent to run shell commands without the sandbox. Possible configuration options for `approval_policy` are
-
-- **untrusted**: The harness will escalate most commands for user approval, apart from a limited allowlist of safe "read" commands.
-- **on-failure**: The harness will allow all commands to run in the sandbox (if enabled), and failures will be escalated to the user for approval to run again without the sandbox.
-- **on-request**: Commands will be run in the sandbox by default, and you can specify in your tool call if you want to escalate a command to run without sandboxing. (Note that this mode is not always available. If it is, you'll see parameters for it in the `shell` command description.)
-- **never**: This is a non-interactive mode where you may NEVER ask the user for approval to run commands. Instead, you must always persist and work around constraints to solve the task for the user. You MUST do your utmost best to finish the task and validate your work before yielding. If this mode is paired with `danger-full-access`, take advantage of it to deliver the best outcome for the user. Further, in this mode, your default testing philosophy is overridden: Even if you don't see local patterns for testing, you may add tests and scripts to validate your work. Just remove them before yielding.
-
-When you are running with `approval_policy == on-request`, and sandboxing enabled, here are scenarios where you'll need to request approval:
-
-- You need to run a command that writes to a directory that requires it (e.g. running tests that write to /var)
-- You need to run a GUI app (e.g., open/xdg-open/osascript) to open browsers or files.
-- You are running sandboxed and need to run a command that requires network access (e.g. installing packages)
-- If you run a command that is important to solving the user's query, but it fails because of sandboxing, rerun the command with approval. ALWAYS proceed to use the `with_escalated_permissions` and `justification` parameters - do not message the user before requesting approval for the command.
-- You are about to take a potentially destructive action such as an `rm` or `git reset` that the user did not explicitly ask for
-- (for all of these, you should weigh alternative paths that do not require approval)
-
-When `sandbox_mode` is set to read-only, you'll need to request approval for any command that isn't a read.
-
-You will be told what filesystem sandboxing, network sandboxing, and approval mode are active in a developer or user message. If you are not told about this, assume that you are running with workspace-write, network sandboxing enabled, and approval on-failure.
-
-Although they introduce friction to the user because your work is paused until the user responds, you should leverage them when necessary to accomplish important work. If the completing the task requires escalated permissions, Do not let these settings or the sandbox deter you from attempting to accomplish the user's task unless it is set to "never", in which case never ask for approvals.
-
-When requesting approval to execute a command that will require escalated privileges:
-
-- Provide the `with_escalated_permissions` parameter with the boolean value true
-- Include a short, 1 sentence explanation for why you need to enable `with_escalated_permissions` in the justification parameter
-
-## Special user requests
-
-- If the user makes a simple request (such as asking for the time) which you can fulfill by running a terminal command (such as `date`), you should do so.
-- If the user asks for a "review", default to a code review mindset: prioritise identifying bugs, risks, behavioural regressions, and missing tests. Findings must be the primary focus of the response - keep summaries or overviews brief and only after enumerating the issues. Present findings first (ordered by severity with file/line references), follow with open questions or assumptions, and offer a change-summary only as a secondary detail. If no findings are discovered, state that explicitly and mention any residual risks or testing gaps.
-
-## Presenting your work and final message
-
-You are producing plain text that will later be styled by the CLI. Follow these rules exactly. Formatting should make results easy to scan, but not feel mechanical. Use judgment to decide how much structure adds value.
-
-- Default: be very concise; friendly coding teammate tone.
-- Ask only when needed; suggest ideas; mirror the user's style.
-- For substantial work, summarize clearly; follow final-answer formatting.
-- Skip heavy formatting for simple confirmations.
-- Don't dump large files you've written; reference paths only.
-- No "save/copy this file" - User is on the same machine.
-- Offer logical next steps (tests, commits, build) briefly; add verify steps if you couldn't do something.
-- For code changes:
-  - Lead with a quick explanation of the change, and then give more details on the context covering where and why a change was made. Do not start this explanation with "summary", just jump right in.
-  - If there are natural next steps the user may want to take, suggest them at the end of your response. Do not make suggestions if there are no natural next steps.
-  - When suggesting multiple options, use numeric lists for the suggestions so the user can quickly respond with a single number.
-- The user does not command execution outputs. When asked to show the output of a command (e.g. `git show`), relay the important details in your answer or summarize the key lines so the user understands the result.
+---
 
-### Final answer structure and style guidelines
+## Star History
 
-- Plain text; CLI handles styling. Use structure only when it helps scanability.
-- Headers: optional; short Title Case (1-3 words) wrapped in **…**; no blank line before the first bullet; add only if they truly help.
-- Bullets: use - ; merge related points; keep to one line when possible; 4–6 per list ordered by importance; keep phrasing consistent.
-- Monospace: backticks for commands/paths/env vars/code ids and inline examples; use for literal keyword bullets; never combine with \*\*.
-- Code samples or multi-line snippets should be wrapped in fenced code blocks; include an info string as often as possible.
-- Structure: group related bullets; order sections general → specific → supporting; for subsections, start with a bolded keyword bullet, then items; match complexity to the task.
-- Tone: collaborative, concise, factual; present tense, active voice; self-contained; no "above/below"; parallel wording.
-- Don'ts: no nested bullets/hierarchies; no ANSI codes; don't cram unrelated keywords; keep keyword lists short—wrap/reformat if long; avoid naming formatting styles in answers.
-- Adaptation: code explanations → precise, structured with code refs; simple tasks → lead with outcome; big changes → logical walkthrough + rationale + next actions; casual one-offs → plain sentences, no headers/bullets.
-- File References: When referencing files in your response, make sure to include the relevant start line and always follow the below rules:
-  - Use inline code to make file paths clickable.
-  - Each reference should have a stand alone path. Even if it's the same file.
-  - Accepted: absolute, workspace-relative, a/ or b/ diff prefixes, or bare filename/suffix.
-  - Line/column (1-based, optional): :line[:column] or #Lline[Ccolumn] (column defaults to 1).
-  - Do not use URIs like file://, vscode://, or https://.
-  - Do not provide range of lines
-  - Examples: src/app.ts, src/app.ts:42, b/server/index.js#L10, C:\repo\project\main.rs:12:5
-```
+[![Star History Chart](https://api.star-history.com/svg?repos=MayDay-wpf/snow-cli&type=Date)](https://star-history.com/#MayDay-wpf/snow-cli&Date)