@taoeffects/crush 0.70.0-taoeffect.1

package/LICENSE.md

@@ -0,0 +1,134 @@
+# Functional Source License, Version 1.1, MIT Future License
+
+## Abbreviation
+
+FSL-1.1-MIT
+
+## Notice
+
+Copyright 2025-2026 Charmbracelet, Inc.
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the MIT license that is effective on the second anniversary of the date we make
+the Software available. On or after that date, you may use the Software under
+the MIT license, in which case the following will apply:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+MIT License
+
+Copyright (c) 2025-03-21 - 2025-05-30 Kujtim Hoxha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,953 @@
+# Crush
+
+<p align="center">
+    <a href="https://stuff.charm.sh/crush/charm-crush.png"><img width="450" alt="Charm Crush Logo" src="https://github.com/user-attachments/assets/cf8ca3ce-8b02-43f0-9d0f-5a331488da4b" /></a><br />
+    <a href="https://github.com/charmbracelet/crush/releases"><img src="https://img.shields.io/github/release/charmbracelet/crush" alt="Latest Release"></a>
+    <a href="https://github.com/charmbracelet/crush/actions"><img src="https://github.com/charmbracelet/crush/actions/workflows/build.yml/badge.svg" alt="Build Status"></a>
+</p>
+
+<p align="center">Your new coding bestie, now available in your favourite terminal.<br />Your tools, your code, and your workflows, wired into your LLM of choice.</p>
+<p align="center">终端里的编程新搭档，<br />无缝接入你的工具、代码与工作流，全面兼容主流 LLM 模型。</p>
+
+<p align="center"><img width="800" alt="Crush Demo" src="https://github.com/user-attachments/assets/58280caf-851b-470a-b6f7-d5c4ea8a1968" /></p>
+
+## Features
+
+- **Multi-Model:** choose from a wide range of LLMs or add your own via OpenAI- or Anthropic-compatible APIs
+- **Flexible:** switch LLMs mid-session while preserving context
+- **Session-Based:** maintain multiple work sessions and contexts per project
+- **LSP-Enhanced:** Crush uses LSPs for additional context, just like you do
+- **Extensible:** add capabilities via MCPs (`http`, `stdio`, and `sse`)
+- **Works Everywhere:** first-class support in every terminal on macOS, Linux, Windows (PowerShell and WSL), Android, FreeBSD, OpenBSD, and NetBSD
+- **Industrial Grade:** built on the Charm ecosystem, powering 25k+ applications, from leading open source projects to business-critical infrastructure
+
+## Installation
+
+Use a package manager:
+
+```bash
+# Homebrew
+brew install charmbracelet/tap/crush
+
+# NPM
+npm install -g @charmland/crush
+
+# Arch Linux (btw)
+yay -S crush-bin
+
+# Nix
+nix run github:numtide/nix-ai-tools#crush
+
+# FreeBSD
+pkg install crush
+```
+
+Windows users:
+
+```bash
+# Winget
+winget install charmbracelet.crush
+
+# Scoop
+scoop bucket add charm https://github.com/charmbracelet/scoop-bucket.git
+scoop install crush
+```
+
+<details>
+<summary><strong>Nix (NUR)</strong></summary>
+
+Crush is available via the official Charm [NUR](https://github.com/nix-community/NUR) in `nur.repos.charmbracelet.crush`, which is the most up-to-date way to get Crush in Nix.
+
+You can also try out Crush via the NUR with `nix-shell`:
+
+```bash
+# Add the NUR channel.
+nix-channel --add https://github.com/nix-community/NUR/archive/main.tar.gz nur
+nix-channel --update
+
+# Get Crush in a Nix shell.
+nix-shell -p '(import <nur> { pkgs = import <nixpkgs> {}; }).repos.charmbracelet.crush'
+```
+
+### NixOS & Home Manager Module Usage via NUR
+
+Crush provides NixOS and Home Manager modules via NUR.
+You can use these modules directly in your flake by importing them from NUR. Since it auto detects whether its a home manager or nixos context you can use the import the exact same way :)
+
+```nix
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    nur.url = "github:nix-community/NUR";
+  };
+
+  outputs = { self, nixpkgs, nur, ... }: {
+    nixosConfigurations.your-hostname = nixpkgs.lib.nixosSystem {
+      system = "x86_64-linux";
+      modules = [
+        nur.modules.nixos.default
+        nur.repos.charmbracelet.modules.crush
+        {
+          programs.crush = {
+            enable = true;
+            settings = {
+              providers = {
+                openai = {
+                  id = "openai";
+                  name = "OpenAI";
+                  base_url = "https://api.openai.com/v1";
+                  type = "openai";
+                  api_key = "sk-fake123456789abcdef...";
+                  models = [
+                    {
+                      id = "gpt-4";
+                      name = "GPT-4";
+                    }
+                  ];
+                };
+              };
+              lsp = {
+                go = { command = "gopls"; enabled = true; };
+                nix = { command = "nil"; enabled = true; };
+              };
+              options = {
+                context_paths = [ "/etc/nixos/configuration.nix" ];
+                tui = { compact_mode = true; };
+                debug = false;
+              };
+            };
+          };
+        }
+      ];
+    };
+  };
+}
+```
+
+</details>
+
+<details>
+<summary><strong>Debian/Ubuntu</strong></summary>
+
+```bash
+sudo mkdir -p /etc/apt/keyrings
+curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
+echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
+sudo apt update && sudo apt install crush
+```
+
+</details>
+
+<details>
+<summary><strong>Fedora/RHEL</strong></summary>
+
+```bash
+echo '[charm]
+name=Charm
+baseurl=https://repo.charm.sh/yum/
+enabled=1
+gpgcheck=1
+gpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo
+sudo yum install crush
+```
+
+</details>
+
+Or, download it:
+
+- [Packages][releases] are available in Debian and RPM formats
+- [Binaries][releases] are available for Linux, macOS, Windows, FreeBSD, OpenBSD, and NetBSD
+
+[releases]: https://github.com/charmbracelet/crush/releases
+
+Or just install it with Go:
+
+```
+go install github.com/charmbracelet/crush@latest
+```
+
+> [!WARNING]
+> Productivity may increase when using Crush and you may find yourself nerd
+> sniped when first using the application. If the symptoms persist, join the
+> [Slack][slack] or [Discord][discord] and nerd snipe the rest of us.
+
+## Getting Started
+
+The quickest way to get started is to grab an API key for your preferred
+provider such as Anthropic, OpenAI, Groq, OpenRouter, or Vercel AI Gateway and just start
+Crush. You'll be prompted to enter your API key.
+
+That said, you can also set environment variables for preferred providers.
+
+| Environment Variable        | Provider                                           |
+| --------------------------- | -------------------------------------------------- |
+| `HYPER_API_KEY`             | Charm Hyper                                        |
+| `ANTHROPIC_API_KEY`         | Anthropic                                          |
+| `OPENAI_API_KEY`            | OpenAI                                             |
+| `VERCEL_API_KEY`            | Vercel AI Gateway                                  |
+| `GEMINI_API_KEY`            | Google Gemini                                      |
+| `SYNTHETIC_API_KEY`         | Synthetic                                          |
+| `ZAI_API_KEY`               | Z.ai                                               |
+| `MINIMAX_API_KEY`           | MiniMax                                            |
+| `HF_TOKEN`                  | Hugging Face Inference                             |
+| `CEREBRAS_API_KEY`          | Cerebras                                           |
+| `OPENROUTER_API_KEY`        | OpenRouter                                         |
+| `IONET_API_KEY`             | io.net                                             |
+| `ALIBABA_SINGAPORE_API_KEY` | Alibaba (Singapore)                                |
+| `GROQ_API_KEY`              | Groq                                               |
+| `AVIAN_API_KEY`             | Avian                                              |
+| `OPENCODE_API_KEY`          | OpenCode Zen & Go                                  |
+| `VERTEXAI_PROJECT`          | Google Cloud VertexAI (Gemini)                     |
+| `VERTEXAI_LOCATION`         | Google Cloud VertexAI (Gemini)                     |
+| `AWS_ACCESS_KEY_ID`         | Amazon Bedrock (Claude)                            |
+| `AWS_SECRET_ACCESS_KEY`     | Amazon Bedrock (Claude)                            |
+| `AWS_REGION`                | Amazon Bedrock (Claude)                            |
+| `AWS_PROFILE`               | Amazon Bedrock (Custom Profile)                    |
+| `AWS_BEARER_TOKEN_BEDROCK`  | Amazon Bedrock                                     |
+| `AZURE_OPENAI_API_ENDPOINT` | Azure OpenAI models                                |
+| `AZURE_OPENAI_API_KEY`      | Azure OpenAI models (optional when using Entra ID) |
+| `AZURE_OPENAI_API_VERSION`  | Azure OpenAI models                                |
+
+### Subscriptions
+
+If you prefer subscription-based usage, here are some plans that work well in
+Crush:
+
+- [Synthetic](https://synthetic.new/pricing)
+- [GLM Coding Plan](https://z.ai/subscribe)
+- [Kimi Code](https://www.kimi.com/membership/pricing)
+- [MiniMax Coding Plan](https://platform.minimax.io/subscribe/coding-plan)
+
+### By the Way
+
+Is there a provider you’d like to see in Crush? Is there an existing model that needs an update?
+
+Crush’s default model listing is managed in [Catwalk](https://github.com/charmbracelet/catwalk), a community-supported, open source repository of Crush-compatible models, and you’re welcome to contribute.
+
+<a href="https://github.com/charmbracelet/catwalk"><img width="174" height="174" alt="Catwalk Badge" src="https://github.com/user-attachments/assets/95b49515-fe82-4409-b10d-5beb0873787d" /></a>
+
+## Configuration
+
+> [!TIP]
+> Crush ships with a builtin `crush-config` skill for configuring itself. In
+> many cases you can simply ask Crush to configure itself.
+
+Crush runs great with no configuration. That said, if you do need or want to
+customize Crush, configuration can be added either local to the project itself,
+or globally, with the following priority:
+
+1. `.crush.json`
+2. `crush.json`
+3. `$HOME/.config/crush/crush.json`
+
+Configuration itself is stored as a JSON object:
+
+```json
+{
+  "this-setting": { "this": "that" },
+  "that-setting": ["ceci", "cela"]
+}
+```
+
+### Web Search
+
+Crush uses DuckDuckGo for web searches by default. You can select Kagi from the
+command menu or configure `web_search` manually with a Kagi Search API key or an
+environment variable reference:
+
+```json
+{
+  "tools": {
+    "web_search": {
+      "search_engine": "kagi",
+      "kagi_api_key": "$KAGI_API_KEY"
+    }
+  }
+}
+```
+
+As an additional note, Crush also stores ephemeral data, such as application
+state, in one additional location:
+
+```bash
+# Unix
+$HOME/.local/share/crush/crush.json
+
+# Windows
+%LOCALAPPDATA%\crush\crush.json
+```
+
+> [!TIP]
+> You can override the user and data config locations by setting:
+>
+> - `CRUSH_GLOBAL_CONFIG`
+> - `CRUSH_GLOBAL_DATA`
+
+### System Prompt
+
+Crush uses its built-in coder system prompt by default. To replace it for a
+project or globally, set `options.system_prompt_path` to a Markdown file:
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "options": {
+    "system_prompt_path": ".crush/system-prompt.md"
+  }
+}
+```
+
+You can also override the configured prompt for a single run with
+`--sys-prompt` or `-p`:
+
+```bash
+crush --sys-prompt /path/to/system-prompt.md
+crush -p /path/to/system-prompt.md run "review this change"
+```
+
+### LSPs
+
+Crush can use LSPs for additional context to help inform its decisions, just
+like you would. LSPs can be added manually like so:
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "lsp": {
+    "go": {
+      "command": "gopls",
+      "env": {
+        "GOTOOLCHAIN": "go1.24.5"
+      }
+    },
+    "typescript": {
+      "command": "typescript-language-server",
+      "args": ["--stdio"]
+    },
+    "nix": {
+      "command": "nil"
+    }
+  }
+}
+```
+
+### MCPs
+
+Crush also supports Model Context Protocol (MCP) servers through three transport
+types: `stdio` for command-line servers, `http` for HTTP endpoints, and `sse`
+for Server-Sent Events.
+
+Shell-style value expansion (`$VAR`, `${VAR:-default}`, `$(command)`, quoting,
+nesting) works in `command`, `args`, `env`, `headers`, and `url`, so
+file-based secrets work out of the box. You can use values like `"$TOKEN"`
+or `"$(cat /path/to/secret/token)"`. Expansion runs through Crush's embedded
+shell, so the same syntax works on every supported system, Windows included.
+
+Unset variables expand to the empty string by default, matching bash. For
+required credentials, use `${VAR:?message}` so an unset variable fails loudly
+at load time with `message` instead of silently resolving to empty:
+
+```json
+{ "api_key": "${CODEBERG_TOKEN:?set CODEBERG_TOKEN}" }
+```
+
+Headers (both MCP `headers` and provider `extra_headers`) whose value
+resolves to the empty string are dropped from the outgoing request rather
+than sent as `Header:`. That keeps optional env-gated headers like
+`"OpenAI-Organization": "$OPENAI_ORG_ID"` clean when the variable is unset.
+
+Provider `extra_body` is a non-expanding JSON passthrough; put env-driven
+values in `extra_headers` or the provider's `api_key` / `base_url`, all of
+which do expand.
+
+> **Security note:** `crush.json` is trusted code. Any `$(...)` in it runs at
+> load time with your shell's privileges, before the UI appears. Don't launch
+> Crush in a directory whose `crush.json` you haven't reviewed.
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "mcp": {
+    "filesystem": {
+      "type": "stdio",
+      "command": "node",
+      "args": ["/path/to/mcp-server.js"],
+      "timeout": 120,
+      "disabled": false,
+      "disabled_tools": ["some-tool-name"],
+      "env": {
+        "NODE_ENV": "production"
+      }
+    },
+    "github": {
+      "type": "http",
+      "url": "https://api.githubcopilot.com/mcp/",
+      "timeout": 120,
+      "disabled": false,
+      "disabled_tools": ["create_issue", "create_pull_request"],
+      "headers": {
+        "Authorization": "Bearer $GH_PAT"
+      }
+    },
+    "streaming-service": {
+      "type": "sse",
+      "url": "https://example.com/mcp/sse",
+      "timeout": 120,
+      "disabled": false,
+      "headers": {
+        "API-Key": "$(echo $API_KEY)"
+      }
+    }
+  }
+}
+```
+
+### Hooks
+
+Crush has preliminary support for hooks. For details, see
+[the hook guide](./docs/hooks/).
+
+### Ignoring Files
+
+Crush respects `.gitignore` files by default, but you can also create a
+`.crushignore` file to specify additional files and directories that Crush
+should ignore. This is useful for excluding files that you want in version
+control but don't want Crush to consider when providing context.
+
+The `.crushignore` file uses the same syntax as `.gitignore` and can be placed
+in the root of your project or in subdirectories.
+
+### Allowing Tools
+
+By default, Crush will ask you for permission before running tool calls. If
+you'd like, you can allow tools to be executed without prompting you for
+permissions. Use this with care.
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "permissions": {
+    "allowed_tools": [
+      "view",
+      "ls",
+      "grep",
+      "edit",
+      "mcp_context7_get-library-doc"
+    ]
+  }
+}
+```
+
+You can also skip all permission prompts entirely by running Crush with the
+`--yolo` flag. Be very, very careful with this feature.
+
+### Disabling Built-In Tools
+
+If you'd like to prevent Crush from using certain built-in tools entirely, you
+can disable them via the `options.disabled_tools` list. Disabled tools are
+completely hidden from the agent.
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "options": {
+    "disabled_tools": ["bash", "sourcegraph"]
+  }
+}
+```
+
+To disable tools from MCP servers, see the [MCP config section](#mcps).
+
+### Disabling Skills
+
+If you'd like to prevent Crush from using certain skills entirely, you can
+disable them via the `options.disabled_skills` list. Disabled skills are hidden
+from the agent, including builtin skills and skills discovered from disk.
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "options": {
+    "disabled_skills": ["crush-config"]
+  }
+}
+```
+
+### Agent Skills
+
+Crush supports the [Agent Skills](https://agentskills.io) open standard for
+extending agent capabilities with reusable skill packages. Skills are folders
+containing a `SKILL.md` file with instructions that Crush can discover and
+activate on demand.
+
+The global paths we looks for skills are:
+
+* `$CRUSH_SKILLS_DIR`
+* `$XDG_CONFIG_HOME/agents/skills` or `~/.config/agents/skills/`
+* `$XDG_CONFIG_HOME/crush/skills` or `~/.config/crush/skills/`
+* `~/.agents/skills/`
+* `~/.claude/skills/`
+* On Windows, we _also_ look at
+  * `%LOCALAPPDATA%\agents\skills\` or `%USERPROFILE%\AppData\Local\agents\skills\`
+  * `%LOCALAPPDATA%\crush\skills\` or `%USERPROFILE%\AppData\Local\crush\skills\`
+* Additional paths configured via `options.skills_paths`
+
+On top of that, we _also_ load skills in your project from the following
+relative paths:
+
+* `.agents/skills`
+* `.crush/skills`
+* `.claude/skills`
+* `.cursor/skills`
+
+```jsonc
+{
+  "$schema": "https://charm.land/crush.json",
+  "options": {
+    "skills_paths": [
+      "~/.config/crush/skills", // Windows: "%LOCALAPPDATA%\\crush\\skills",
+      "./project-skills",
+    ],
+  },
+}
+```
+
+You can get started with example skills from [anthropics/skills](https://github.com/anthropics/skills):
+
+```bash
+# Unix
+mkdir -p ~/.config/crush/skills
+cd ~/.config/crush/skills
+git clone https://github.com/anthropics/skills.git _temp
+mv _temp/skills/* . && rm -rf _temp
+```
+
+```powershell
+# Windows (PowerShell)
+mkdir -Force "$env:LOCALAPPDATA\crush\skills"
+cd "$env:LOCALAPPDATA\crush\skills"
+git clone https://github.com/anthropics/skills.git _temp
+mv _temp/skills/* . ; rm -r -force _temp
+```
+
+#### User-Invocable Skills
+
+Skills can be made invocable as commands from the commands palette (Ctrl+P). Add `user-invocable: true` to the skill's YAML frontmatter:
+
+```yaml
+---
+name: my-skill
+description: A skill that can be invoked as a command.
+user-invocable: true
+---
+```
+
+User-invocable skills appear in the commands palette with a `user:` or `project:` prefix:
+- Skills from global directories show as `user:skill-name`
+- Skills from project directories show as `project:skill-name`
+
+When invoked, the skill's instructions are loaded into the conversation context.
+
+To prevent the model from auto-triggering a skill (while still allowing user invocation), add `disable-model-invocation: true`:
+
+```yaml
+---
+name: my-skill
+description: Only invocable by users, not the model.
+user-invocable: true
+disable-model-invocation: true
+---
+```
+
+Skills with `disable-model-invocation` won't appear in the model's available skills list but can still be invoked manually by users.
+
+### Desktop notifications
+
+Crush sends desktop notifications when a tool call requires permission and when
+the agent finishes its turn. They're only sent when the terminal window isn't
+focused _and_ your terminal supports reporting the focus state.
+
+```jsonc
+{
+  "$schema": "https://charm.land/crush.json",
+  "options": {
+    "disable_notifications": false, // default
+  },
+}
+```
+
+To disable desktop notifications, set `disable_notifications` to `true` in your
+configuration. On macOS, notifications currently lack icons due to platform
+limitations.
+
+### Initialization
+
+When you initialize a project, Crush analyzes your codebase and creates
+a context file that helps it work more effectively in future sessions.
+By default, this file is named `AGENTS.md`, but you can customize the
+name and location with the `initialize_as` option:
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "options": {
+    "initialize_as": "AGENTS.md"
+  }
+}
+```
+
+This is useful if you prefer a different naming convention or want to
+place the file in a specific directory (e.g., `CRUSH.md` or
+`docs/LLMs.md`). Crush will fill the file with project-specific context
+like build commands, code patterns, and conventions it discovered during
+initialization.
+
+### Attribution Settings
+
+By default, Crush adds attribution information to Git commits and pull requests
+it creates. You can customize this behavior with the `attribution` option:
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "options": {
+    "attribution": {
+      "trailer_style": "co-authored-by",
+      "generated_with": true
+    }
+  }
+}
+```
+
+- `trailer_style`: Controls the attribution trailer added to commit messages
+  (default: `assisted-by`)
+  - `assisted-by`: Adds `Assisted-by: Crush:[ModelID]` as specified in [the convention](https://docs.kernel.org/process/coding-assistants.html#attribution)
+  - `co-authored-by`: Adds `Co-Authored-By: Crush <crush@charm.land>`
+  - `none`: No attribution trailer
+- `generated_with`: When true (default), adds `💘 Generated with Crush` line to
+  commit messages and PR descriptions
+
+### Custom Providers
+
+Crush supports custom provider configurations for both OpenAI-compatible and
+Anthropic-compatible APIs.
+
+> [!NOTE]
+> Note that we support two "types" for OpenAI. Make sure to choose the right one
+> to ensure the best experience!
+>
+> - `openai` should be used when proxying or routing requests through OpenAI.
+> - `openai-compat` should be used when using non-OpenAI providers that have OpenAI-compatible APIs.
+
+#### OpenAI-Compatible APIs
+
+Here’s an example configuration for Deepseek, which uses an OpenAI-compatible
+API. Don't forget to set `DEEPSEEK_API_KEY` in your environment.
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "providers": {
+    "deepseek": {
+      "type": "openai-compat",
+      "base_url": "https://api.deepseek.com/v1",
+      "api_key": "$DEEPSEEK_API_KEY",
+      "models": [
+        {
+          "id": "deepseek-chat",
+          "name": "Deepseek V3",
+          "cost_per_1m_in": 0.27,
+          "cost_per_1m_out": 1.1,
+          "cost_per_1m_in_cached": 0.07,
+          "cost_per_1m_out_cached": 1.1,
+          "context_window": 64000,
+          "default_max_tokens": 5000
+        }
+      ]
+    }
+  }
+}
+```
+
+#### Anthropic-Compatible APIs
+
+Custom Anthropic-compatible providers follow this format:
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "providers": {
+    "custom-anthropic": {
+      "type": "anthropic",
+      "base_url": "https://api.anthropic.com/v1",
+      "api_key": "$ANTHROPIC_API_KEY",
+      "extra_headers": {
+        "anthropic-version": "2023-06-01"
+      },
+      "models": [
+        {
+          "id": "claude-sonnet-4-20250514",
+          "name": "Claude Sonnet 4",
+          "cost_per_1m_in": 3,
+          "cost_per_1m_out": 15,
+          "cost_per_1m_in_cached": 3.75,
+          "cost_per_1m_out_cached": 0.3,
+          "context_window": 200000,
+          "default_max_tokens": 50000,
+          "can_reason": true,
+          "supports_attachments": true
+        }
+      ]
+    }
+  }
+}
+```
+
+### Amazon Bedrock
+
+Crush currently supports running Anthropic models through Bedrock, with caching disabled.
+
+- A Bedrock provider will appear once you have AWS configured, i.e. `aws configure`
+- Crush also expects the `AWS_REGION` or `AWS_DEFAULT_REGION` to be set
+- To use a specific AWS profile set `AWS_PROFILE` in your environment, i.e. `AWS_PROFILE=myprofile crush`
+- Alternatively to `aws configure`, you can also just set `AWS_BEARER_TOKEN_BEDROCK`
+
+### Vertex AI Platform
+
+Vertex AI will appear in the list of available providers when `VERTEXAI_PROJECT` and `VERTEXAI_LOCATION` are set. You will also need to be authenticated:
+
+```bash
+gcloud auth application-default login
+```
+
+To add specific models to the configuration, configure as such:
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "providers": {
+    "vertexai": {
+      "models": [
+        {
+          "id": "claude-sonnet-4@20250514",
+          "name": "VertexAI Sonnet 4",
+          "cost_per_1m_in": 3,
+          "cost_per_1m_out": 15,
+          "cost_per_1m_in_cached": 3.75,
+          "cost_per_1m_out_cached": 0.3,
+          "context_window": 200000,
+          "default_max_tokens": 50000,
+          "can_reason": true,
+          "supports_attachments": true
+        }
+      ]
+    }
+  }
+}
+```
+
+### Local Models
+
+Local models can also be configured via OpenAI-compatible API. Here are two common examples:
+
+#### Ollama
+
+```json
+{
+  "providers": {
+    "ollama": {
+      "name": "Ollama",
+      "base_url": "http://localhost:11434/v1/",
+      "type": "openai-compat",
+      "models": [
+        {
+          "name": "Qwen 3 30B",
+          "id": "qwen3:30b",
+          "context_window": 256000,
+          "default_max_tokens": 20000
+        }
+      ]
+    }
+  }
+}
+```
+
+#### LM Studio
+
+```json
+{
+  "providers": {
+    "lmstudio": {
+      "name": "LM Studio",
+      "base_url": "http://localhost:1234/v1/",
+      "type": "openai-compat",
+      "models": [
+        {
+          "name": "Qwen 3 30B",
+          "id": "qwen/qwen3-30b-a3b-2507",
+          "context_window": 256000,
+          "default_max_tokens": 20000
+        }
+      ]
+    }
+  }
+}
+```
+
+## Logging
+
+Sometimes you need to look at logs. Luckily, Crush logs all sorts of
+stuff. Logs are stored in `./.crush/logs/crush.log` relative to the project.
+
+The CLI also contains some helper commands to make perusing recent logs easier:
+
+```bash
+# Print the last 1000 lines
+crush logs
+
+# Print the last 500 lines
+crush logs --tail 500
+
+# Follow logs in real time
+crush logs --follow
+```
+
+Want more logging? Run `crush` with the `--debug` flag, or enable it in the
+config:
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "options": {
+    "debug": true,
+    "debug_lsp": true
+  }
+}
+```
+
+## Provider Auto-Updates
+
+By default, Crush automatically checks for the latest and greatest list of
+providers and models from [Catwalk](https://github.com/charmbracelet/catwalk),
+the open source Crush provider database. This means that when new providers and
+models are available, or when model metadata changes, Crush automatically
+updates your local configuration.
+
+### Disabling automatic provider updates
+
+For those with restricted internet access, or those who prefer to work in
+air-gapped environments, this might not be want you want, and this feature can
+be disabled.
+
+To disable automatic provider updates, set `disable_provider_auto_update` into
+your `crush.json` config:
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "options": {
+    "disable_provider_auto_update": true
+  }
+}
+```
+
+Or set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment variable:
+
+```bash
+export CRUSH_DISABLE_PROVIDER_AUTO_UPDATE=1
+```
+
+### Manually updating providers
+
+Manually updating providers is possible with the `crush update-providers`
+command:
+
+```bash
+# Update providers remotely from Catwalk.
+crush update-providers
+
+# Update providers from a custom Catwalk base URL.
+crush update-providers https://example.com/
+
+# Update providers from a local file.
+crush update-providers /path/to/local-providers.json
+
+# Reset providers to the embedded version, embedded at crush at build time.
+crush update-providers embedded
+
+# For more info:
+crush update-providers --help
+```
+
+## Metrics
+
+Crush records pseudonymous usage metrics (tied to a device-specific hash),
+which maintainers rely on to inform development and support priorities. The
+metrics include solely usage metadata; prompts and responses are NEVER
+collected.
+
+Details on exactly what’s collected are in the source code ([here](https://github.com/charmbracelet/crush/tree/main/internal/event)
+and [here](https://github.com/charmbracelet/crush/blob/main/internal/llm/agent/event.go)).
+
+You can opt out of metrics collection at any time by setting the environment
+variable by setting the following in your environment:
+
+```bash
+export CRUSH_DISABLE_METRICS=1
+```
+
+Or by setting the following in your config:
+
+```json
+{
+  "options": {
+    "disable_metrics": true
+  }
+}
+```
+
+Crush also respects the [`DO_NOT_TRACK`](https://donottrack.sh/) convention
+which can be enabled via `export DO_NOT_TRACK=1`.
+
+## Q&A
+
+### Why is clipboard copy and paste not working?
+
+Installing an extra tool might be needed on Unix-like environments.
+
+| Environment         | Tool                     |
+| ------------------- | ------------------------ |
+| Windows             | Native support           |
+| macOS               | Native support           |
+| Linux/BSD + Wayland | `wl-copy` and `wl-paste` |
+| Linux/BSD + X11     | `xclip` or `xsel`        |
+
+## Contributing
+
+See the [contributing guide](https://github.com/charmbracelet/crush?tab=contributing-ov-file#contributing).
+
+## Whatcha think?
+
+We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on:
+
+- [Twitter](https://twitter.com/charmcli)
+- [Slack][slack]
+- [Discord][discord]
+- [The Fediverse](https://mastodon.social/@charmcli)
+- [Bluesky](https://bsky.app/profile/charm.land)
+
+[slack]: https://charm.land/slack
+[discord]: https://charm.land/discord
+
+## License
+
+[FSL-1.1-MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE.md)
+
+---
+
+Part of [Charm](https://charm.land).
+
+<a href="https://charm.land/"><img alt="The Charm logo" width="400" src="https://stuff.charm.sh/charm-banner-softy.jpg" /></a>
+
+<!--prettier-ignore-->
+Charm热爱开源 • Charm loves open source

package/install.js

@@ -0,0 +1,81 @@
+import { createWriteStream } from "node:fs";
+import { mkdtemp, rename, stat, rm } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { Readable } from "node:stream";
+import { pipeline } from "node:stream/promises";
+
+import { ProxyAgent } from "proxy-agent";
+import tar from "tar";
+
+import {
+  assertSafeArchivePath,
+  binaryPath,
+  makeBinaryExecutable,
+  prepareVendorDir,
+  readPackageMetadata,
+  sha256File,
+  validateArchiveMetadata,
+  vendorDir,
+} from "./lib.js";
+
+async function downloadArchive(url, destination) {
+  const response = await fetch(url, {
+    agent: new ProxyAgent(),
+    redirect: "follow",
+  });
+
+  if (!response.ok) {
+    throw new Error(`Failed to download ${url}: ${response.status} ${response.statusText}`);
+  }
+  if (!response.body) {
+    throw new Error(`Failed to download ${url}: response body is empty`);
+  }
+
+  await pipeline(Readable.fromWeb(response.body), createWriteStream(destination, { mode: 0o600 }));
+}
+
+async function extractBinary(archivePath, archive) {
+  await tar.x({
+    cwd: vendorDir,
+    file: archivePath,
+    filter(path, entry) {
+      assertSafeArchivePath(path, archive);
+      return path === `${archive.wrappedIn}/${archive.bin}` && entry.type === "File";
+    },
+    strip: 1,
+  });
+
+  await rename(join(vendorDir, archive.bin), binaryPath);
+  await makeBinaryExecutable();
+}
+
+async function install() {
+  const { archive, key } = await readPackageMetadata();
+  validateArchiveMetadata(archive);
+
+  const tempDir = await mkdtemp(join(tmpdir(), "crush-npm-"));
+  const archivePath = join(tempDir, archive.name);
+
+  try {
+    console.log(`Downloading Crush for ${key}...`);
+    await downloadArchive(archive.url, archivePath);
+
+    const digest = await sha256File(archivePath);
+    if (digest.toLowerCase() !== archive.checksum.digest.toLowerCase()) {
+      throw new Error(`Checksum mismatch for ${archive.name}: expected ${archive.checksum.digest}, got ${digest}`);
+    }
+
+    await prepareVendorDir();
+    await extractBinary(archivePath, archive);
+    await stat(binaryPath);
+    console.log(`Installed Crush to ${binaryPath}`);
+  } finally {
+    await rm(tempDir, { force: true, recursive: true });
+  }
+}
+
+install().catch((error) => {
+  console.error(`Failed to install Crush: ${error.message}`);
+  process.exit(1);
+});

package/lib.js

@@ -0,0 +1,84 @@
+import { createHash } from "node:crypto";
+import { createReadStream } from "node:fs";
+import { chmod, mkdir, readFile, rm } from "node:fs/promises";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+
+export const packageRoot = dirname(fileURLToPath(import.meta.url));
+export const vendorDir = join(packageRoot, "vendor", "crush");
+export const binaryName = process.platform === "win32" ? "crush.exe" : "crush";
+export const binaryPath = join(vendorDir, binaryName);
+
+const platformKeys = new Map([
+  ["linux:x64", "linux-x64"],
+  ["linux:arm64", "linux-arm64"],
+  ["darwin:x64", "darwin-x64"],
+  ["darwin:arm64", "darwin-arm64"],
+]);
+
+export function platformKey(platform = process.platform, arch = process.arch) {
+  const key = platformKeys.get(`${platform}:${arch}`);
+  if (!key) {
+    throw new Error(`Unsupported platform: ${platform}/${arch}`);
+  }
+  return key;
+}
+
+export async function readPackageMetadata() {
+  const packageJSON = JSON.parse(await readFile(join(packageRoot, "package.json"), "utf8"));
+  const key = platformKey();
+  const archive = packageJSON.crush?.archives?.[key];
+  if (!archive) {
+    throw new Error(`No Crush archive metadata for platform ${key}`);
+  }
+  return { archive, key, packageJSON };
+}
+
+export async function prepareVendorDir() {
+  await rm(vendorDir, { force: true, recursive: true });
+  await mkdir(vendorDir, { recursive: true });
+}
+
+export async function makeBinaryExecutable(path = binaryPath) {
+  if (process.platform !== "win32") {
+    await chmod(path, 0o755);
+  }
+}
+
+export function validateArchiveMetadata(archive) {
+  if (!archive || typeof archive !== "object") {
+    throw new Error("Missing archive metadata");
+  }
+  for (const field of ["name", "url", "wrappedIn", "bin"]) {
+    if (typeof archive[field] !== "string" || archive[field] === "") {
+      throw new Error(`Archive metadata is missing ${field}`);
+    }
+  }
+  if (archive.checksum?.algorithm !== "sha256") {
+    throw new Error("Archive checksum algorithm must be sha256");
+  }
+  if (typeof archive.checksum.digest !== "string" || !/^[a-f0-9]{64}$/i.test(archive.checksum.digest)) {
+    throw new Error("Archive checksum digest must be a SHA-256 hex string");
+  }
+}
+
+export async function sha256File(path) {
+  const hash = createHash("sha256");
+  await new Promise((resolve, reject) => {
+    createReadStream(path)
+      .on("error", reject)
+      .on("data", (chunk) => hash.update(chunk))
+      .on("end", resolve);
+  });
+  return hash.digest("hex");
+}
+
+export function assertSafeArchivePath(path, archive) {
+  const expectedPath = `${archive.wrappedIn}/${archive.bin}`;
+  if (path === expectedPath) {
+    return;
+  }
+  if (path.startsWith("/") || path.includes("..")) {
+    throw new Error(`Unsafe archive entry path: ${path}`);
+  }
+}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@taoeffects/crush",
+  "type": "module",
+  "version": "0.70.0-taoeffect.1",
+  "description": "A terminal-based AI coding assistant forked from Charm Crush.",
+  "scripts": {
+    "postinstall": "node install.js",
+    "run": "node run-crush.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/taoeffect/crush.git"
+  },
+  "license": "FSL-1.1-MIT",
+  "bugs": {
+    "url": "https://github.com/taoeffect/crush/issues"
+  },
+  "bin": {
+    "crush": "run-crush.js"
+  },
+  "dependencies": {
+    "proxy-agent": "8.0.1",
+    "tar": "7.5.13"
+  },
+  "files": [
+    "install.js",
+    "run-crush.js",
+    "lib.js",
+    "README.md",
+    "LICENSE.md"
+  ],
+  "crush": {
+    "repo": "taoeffect/crush",
+    "archives": {
+      "linux-x64": {
+        "name": "crush_0.70.0-taoeffect.1_Linux_x86_64.tar.gz",
+        "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.1/crush_0.70.0-taoeffect.1_Linux_x86_64.tar.gz",
+        "checksum": {
+          "algorithm": "sha256",
+          "digest": "5cc75b9628166c0247a77d5213887598039e32c2a0daebbb09ce473ad5515d9f"
+        },
+        "wrappedIn": "crush_0.70.0-taoeffect.1_Linux_x86_64",
+        "bin": "crush"
+      },
+      "linux-arm64": {
+        "name": "crush_0.70.0-taoeffect.1_Linux_arm64.tar.gz",
+        "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.1/crush_0.70.0-taoeffect.1_Linux_arm64.tar.gz",
+        "checksum": {
+          "algorithm": "sha256",
+          "digest": "4db393c3b07f03e117ce09d3a36ccfd2951e1600f15363a632b008e59b3114ae"
+        },
+        "wrappedIn": "crush_0.70.0-taoeffect.1_Linux_arm64",
+        "bin": "crush"
+      },
+      "darwin-x64": {
+        "name": "crush_0.70.0-taoeffect.1_Darwin_x86_64.tar.gz",
+        "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.1/crush_0.70.0-taoeffect.1_Darwin_x86_64.tar.gz",
+        "checksum": {
+          "algorithm": "sha256",
+          "digest": "c63b4689d7b509335daf6ed80f542f0d342afaa21c0303ed766d1625fc31c717"
+        },
+        "wrappedIn": "crush_0.70.0-taoeffect.1_Darwin_x86_64",
+        "bin": "crush"
+      },
+      "darwin-arm64": {
+        "name": "crush_0.70.0-taoeffect.1_Darwin_arm64.tar.gz",
+        "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.1/crush_0.70.0-taoeffect.1_Darwin_arm64.tar.gz",
+        "checksum": {
+          "algorithm": "sha256",
+          "digest": "93690d7e33900fcf99278ce09531d87aa81cec8e577922a823c17c00d3a409d6"
+        },
+        "wrappedIn": "crush_0.70.0-taoeffect.1_Darwin_arm64",
+        "bin": "crush"
+      }
+    }
+  }
+}

package/run-crush.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+import { spawn } from "node:child_process";
+import { stat } from "node:fs/promises";
+
+import { binaryPath } from "./lib.js";
+
+async function run() {
+  try {
+    await stat(binaryPath);
+  } catch {
+    console.error(`Crush binary is not installed at ${binaryPath}. Try reinstalling @taoeffects/crush.`);
+    process.exit(1);
+  }
+
+  const child = spawn(binaryPath, process.argv.slice(2), {
+    stdio: "inherit",
+  });
+
+  child.on("error", (error) => {
+    console.error(`Failed to run Crush: ${error.message}`);
+    process.exit(1);
+  });
+
+  child.on("exit", (code, signal) => {
+    if (signal) {
+      process.kill(process.pid, signal);
+      return;
+    }
+    process.exit(code ?? 0);
+  });
+}
+
+run().catch((error) => {
+  console.error(`Failed to run Crush: ${error.message}`);
+  process.exit(1);
+});