@charmland/crush 0.2.1 → 0.3.0

package/README.md

@@ -35,11 +35,15 @@ yay -S crush-bin
 
 # Nix
 nix run github:numtide/nix-ai-tools#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 [NUR](https://github.com/nix-community/NUR) in `nur.repos.charmbracelet.crush`.
 
 You can also try out Crush via `nix-shell`:
@@ -138,19 +142,29 @@ 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`
+1. `.crush.json`
+2. `crush.json`
+3. `$HOME/.config/crush/crush.json` (Windows: `%USERPROFILE%\AppData\Local\crush\crush.json`)
 
 Configuration itself is stored as a JSON object:
 
 ```json
 {
-   "this-setting": { }
-   "that-setting": { }
+   "this-setting": {"this": "that"},
+   "that-setting": ["ceci", "cela"]
 }
 ```
 
+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
+```
+
 ### LSPs
 
 Crush can use LSPs for additional context to help inform its decisions, just
@@ -221,10 +235,10 @@ 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.
 
-### Whitelisting Tools
+### Allowing Tools
 
 By default, Crush will ask you for permission before running tool calls. If
-you'd like, you can whitelist tools to be executed without prompting you for
+you'd like, you can allow tools to be executed without prompting you for
 permissions. Use this with care.
 
 ```json
@@ -245,6 +259,54 @@ permissions. Use this with care.
 You can also skip all permission prompts entirely by running Crush with the
 `--yolo` flag. Be very, very careful with this feature.
 
+### 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",
+      "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",
+      "models": [
+        {
+          "name": "Qwen 3 30B",
+          "id": "qwen/qwen3-30b-a3b-2507",
+          "context_window": 256000,
+          "default_max_tokens": 20000
+        }
+      ]
+    }
+  }
+}
+```
+
 ### Custom Providers
 
 Crush supports custom provider configurations for both OpenAI-compatible and
@@ -314,6 +376,59 @@ Custom Anthropic-compatible providers follow this format:
 }
 ```
 
+### 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`
+
+### 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
+        }
+      ]
+    }
+  }
+}
+```
+
+## A Note on Claude Max and GitHub Copilot
+
+Crush only supports model providers through official, compliant APIs. We do not
+support or endorse any methods that rely on personal Claude Max and GitHub Copilot
+accounts or OAuth workarounds, which may violate Anthropic and Microsoft’s
+Terms of Service.
+
+We’re committed to building sustainable, trusted integrations with model
+providers. If you’re a provider interested in working with us, 
+[reach out](mailto:vt100@charm.sh).
+
 ## Logging
 
 Sometimes you need to look at logs. Luckily, Crush logs all sorts of

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@charmland/crush",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "A powerful terminal-based AI assistant for developers, providing intelligent coding assistance directly in your terminal.",
   "scripts": {
     "postinstall": "node install.js",
@@ -26,82 +26,82 @@
   },
   "archives": {
     "darwin-arm64": {
-      "name": "crush_0.2.1_Darwin_arm64.tar.gz",
-      "url": "https://github.com/charmbracelet/crush/releases/download/v0.2.1/crush_0.2.1_Darwin_arm64.tar.gz",
+      "name": "crush_0.3.0_Darwin_arm64.tar.gz",
+      "url": "https://github.com/charmbracelet/crush/releases/download/v0.3.0/crush_0.3.0_Darwin_arm64.tar.gz",
       "bins": [
         "crush"
       ],
       "format": "tar.gz",
       "checksum": {
         "algorithm": "sha256",
-        "digest": "d15e46a04643ccc0668927bb6fa3f01204ba8b61ddf3deda59ff81fa1156a9f3"
+        "digest": "baee31303dc479621f3bcc906240d14fb1c7f5c2c722dfb55abb386cf34b8901"
       },
-      "wrappedIn": "crush_0.2.1_Darwin_arm64"
+      "wrappedIn": "crush_0.3.0_Darwin_arm64"
     },
     "darwin-x64": {
-      "name": "crush_0.2.1_Darwin_x86_64.tar.gz",
-      "url": "https://github.com/charmbracelet/crush/releases/download/v0.2.1/crush_0.2.1_Darwin_x86_64.tar.gz",
+      "name": "crush_0.3.0_Darwin_x86_64.tar.gz",
+      "url": "https://github.com/charmbracelet/crush/releases/download/v0.3.0/crush_0.3.0_Darwin_x86_64.tar.gz",
       "bins": [
         "crush"
       ],
       "format": "tar.gz",
       "checksum": {
         "algorithm": "sha256",
-        "digest": "f16a2c3ea397970fa40149f129eedfcfca4544c7fe6248009e3ca2be026badbc"
+        "digest": "3301c0c16c49b892e6ae0f77cf3c35ea25187738af85ea2bbe40b38acdde69d5"
       },
-      "wrappedIn": "crush_0.2.1_Darwin_x86_64"
+      "wrappedIn": "crush_0.3.0_Darwin_x86_64"
     },
     "linux-arm64": {
-      "name": "crush_0.2.1_Linux_arm64.tar.gz",
-      "url": "https://github.com/charmbracelet/crush/releases/download/v0.2.1/crush_0.2.1_Linux_arm64.tar.gz",
+      "name": "crush_0.3.0_Linux_arm64.tar.gz",
+      "url": "https://github.com/charmbracelet/crush/releases/download/v0.3.0/crush_0.3.0_Linux_arm64.tar.gz",
       "bins": [
         "crush"
       ],
       "format": "tar.gz",
       "checksum": {
         "algorithm": "sha256",
-        "digest": "8a0f219e141bccf026263a6581edfe432418c4518da6dea64bc55e19fd466c64"
+        "digest": "115d9589648c9602b3fea3301648031b014e1fd5304db428d50294ed60d9eb9c"
       },
-      "wrappedIn": "crush_0.2.1_Linux_arm64"
+      "wrappedIn": "crush_0.3.0_Linux_arm64"
     },
     "linux-x64": {
-      "name": "crush_0.2.1_Linux_x86_64.tar.gz",
-      "url": "https://github.com/charmbracelet/crush/releases/download/v0.2.1/crush_0.2.1_Linux_x86_64.tar.gz",
+      "name": "crush_0.3.0_Linux_x86_64.tar.gz",
+      "url": "https://github.com/charmbracelet/crush/releases/download/v0.3.0/crush_0.3.0_Linux_x86_64.tar.gz",
       "bins": [
         "crush"
       ],
       "format": "tar.gz",
       "checksum": {
         "algorithm": "sha256",
-        "digest": "5a0adb1e0b3d4969781d35bcdc725fe1b1f79e38660916204c9bb166d5f3ef7e"
+        "digest": "ef9b8f4950842268effc6df0dac849766ff95e5c19fddc8036370566d8aa6c71"
       },
-      "wrappedIn": "crush_0.2.1_Linux_x86_64"
+      "wrappedIn": "crush_0.3.0_Linux_x86_64"
     },
     "win32-arm64": {
-      "name": "crush_0.2.1_Windows_arm64.zip",
-      "url": "https://github.com/charmbracelet/crush/releases/download/v0.2.1/crush_0.2.1_Windows_arm64.zip",
+      "name": "crush_0.3.0_Windows_arm64.zip",
+      "url": "https://github.com/charmbracelet/crush/releases/download/v0.3.0/crush_0.3.0_Windows_arm64.zip",
       "bins": [
         "crush.exe"
       ],
       "format": "zip",
       "checksum": {
         "algorithm": "sha256",
-        "digest": "7a0cc2630d4e325a95211042b0c31c4855d9bbedacf33436d9f3dbed918fd6f8"
+        "digest": "13f608b4e4e79a62095c0b9131bab2daedf9d33d847308e668f92b206cef6bb0"
       },
-      "wrappedIn": "crush_0.2.1_Windows_arm64"
+      "wrappedIn": "crush_0.3.0_Windows_arm64"
     },
     "win32-x64": {
-      "name": "crush_0.2.1_Windows_x86_64.zip",
-      "url": "https://github.com/charmbracelet/crush/releases/download/v0.2.1/crush_0.2.1_Windows_x86_64.zip",
+      "name": "crush_0.3.0_Windows_x86_64.zip",
+      "url": "https://github.com/charmbracelet/crush/releases/download/v0.3.0/crush_0.3.0_Windows_x86_64.zip",
       "bins": [
         "crush.exe"
       ],
       "format": "zip",
       "checksum": {
         "algorithm": "sha256",
-        "digest": "9ea6da3c55db227f0b954848286eb16585bb035afaa73ecb8f86891f9040f154"
+        "digest": "f3f08e3a91fbede3f90f6d9c19fb95d388953e0a28b3b3a50a3f0cfd0f2ebd52"
       },
-      "wrappedIn": "crush_0.2.1_Windows_x86_64"
+      "wrappedIn": "crush_0.3.0_Windows_x86_64"
     }
   }
 }