@charmland/crush 0.8.0 → 0.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +37 -28
  2. package/package.json +25 -25
package/README.md CHANGED
@@ -157,8 +157,8 @@ Configuration itself is stored as a JSON object:
157
157
 
158
158
  ```json
159
159
  {
160
- "this-setting": {"this": "that"},
161
- "that-setting": ["ceci", "cela"]
160
+ "this-setting": { "this": "that" },
161
+ "that-setting": ["ceci", "cela"]
162
162
  }
163
163
  ```
164
164
 
@@ -390,9 +390,9 @@ Custom Anthropic-compatible providers follow this format:
390
390
 
391
391
  Crush currently supports running Anthropic models through Bedrock, with caching disabled.
392
392
 
393
- * A Bedrock provider will appear once you have AWS configured, i.e. `aws configure`
394
- * Crush also expects the `AWS_REGION` or `AWS_DEFAULT_REGION` to be set
395
- * To use a specific AWS profile set `AWS_PROFILE` in your environment, i.e. `AWS_PROFILE=myprofile crush`
393
+ - A Bedrock provider will appear once you have AWS configured, i.e. `aws configure`
394
+ - Crush also expects the `AWS_REGION` or `AWS_DEFAULT_REGION` to be set
395
+ - To use a specific AWS profile set `AWS_PROFILE` in your environment, i.e. `AWS_PROFILE=myprofile crush`
396
396
 
397
397
  ### Vertex AI Platform
398
398
 
@@ -428,17 +428,6 @@ To add specific models to the configuration, configure as such:
428
428
  }
429
429
  ```
430
430
 
431
- ## A Note on Claude Max and GitHub Copilot
432
-
433
- Crush only supports model providers through official, compliant APIs. We do not
434
- support or endorse any methods that rely on personal Claude Max and GitHub Copilot
435
- accounts or OAuth workarounds, which may violate Anthropic and Microsoft’s
436
- Terms of Service.
437
-
438
- We’re committed to building sustainable, trusted integrations with model
439
- providers. If you’re a provider interested in working with us,
440
- [reach out](mailto:vt100@charm.sh).
441
-
442
431
  ## Logging
443
432
 
444
433
  Sometimes you need to look at logs. Luckily, Crush logs all sorts of
@@ -470,14 +459,20 @@ config:
470
459
  }
471
460
  ```
472
461
 
473
- ## Disabling providers auto-update
462
+ ## Disabling Provider Auto-Updates
474
463
 
475
- Crush automatically fetches the updated list of providers and models from
476
- [Catwalk](https://github.com/charmbracelet/catwalk). We know some environments
477
- have restricted internet access, so if you need to disable this you have two
478
- options:
464
+ By default, Crush automatically checks for the latest and greatest list of
465
+ providers and models from [Catwalk](https://github.com/charmbracelet/catwalk),
466
+ the open source Crush provider database. This means that when new providers and
467
+ models are available, or when model metadata changes, Crush automatically
468
+ updates your local configuration.
479
469
 
480
- Set `disable_provider_auto_update` into your `crush.json` config:
470
+ For those with restricted internet access, or those who prefer to work in
471
+ air-gapped environments, this might not be want you want, and this feature can
472
+ be disabled.
473
+
474
+ To disable automatic provider updates, set `disable_provider_auto_update` into
475
+ your `crush.json` config:
481
476
 
482
477
  ```json
483
478
  {
@@ -488,15 +483,16 @@ Set `disable_provider_auto_update` into your `crush.json` config:
488
483
  }
489
484
  ```
490
485
 
491
- Or alternatively set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment
492
- variable:
486
+ Or set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment variable:
493
487
 
494
488
  ```bash
495
489
  export CRUSH_DISABLE_PROVIDER_AUTO_UPDATE=1
496
490
  ```
497
491
 
498
- With that set, you'll have to manually update providers from time to time. It's
499
- possible to do that with the `crush update-providers` command:
492
+ ### Manually updating providers
493
+
494
+ Manually updating providers is possible with the `crush update-providers`
495
+ command:
500
496
 
501
497
  ```bash
502
498
  # Update providers remotely from Catwalk.
@@ -508,11 +504,24 @@ crush update-providers https://example.com/
508
504
  # Update providers from a local file.
509
505
  crush update-providers /path/to/local-providers.json
510
506
 
511
- # Update providers from the embedded version.
512
- # (Crush ships with an embedded copy of Catwalk on the time of the release).
507
+ # Reset providers to the embedded version, embedded at crush at build time.
513
508
  crush update-providers embedded
509
+
510
+ # For more info:
511
+ crush update-providers --help
514
512
  ```
515
513
 
514
+ ## A Note on Claude Max and GitHub Copilot
515
+
516
+ Crush only supports model providers through official, compliant APIs. We do not
517
+ support or endorse any methods that rely on personal Claude Max and GitHub
518
+ Copilot accounts or OAuth workarounds, which violate Anthropic and
519
+ Microsoft’s Terms of Service.
520
+
521
+ We’re committed to building sustainable, trusted integrations with model
522
+ providers. If you’re a provider interested in working with us,
523
+ [reach out](mailto:vt100@charm.sh).
524
+
516
525
  ## Whatcha think?
517
526
 
518
527
  We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@charmland/crush",
3
- "version": "0.8.0",
3
+ "version": "0.8.2",
4
4
  "description": "A powerful terminal-based AI assistant for developers, providing intelligent coding assistance directly in your terminal.",
5
5
  "scripts": {
6
6
  "postinstall": "node install.js",
@@ -26,82 +26,82 @@
26
26
  },
27
27
  "archives": {
28
28
  "darwin-arm64": {
29
- "name": "crush_0.8.0_Darwin_arm64.tar.gz",
30
- "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.0/crush_0.8.0_Darwin_arm64.tar.gz",
29
+ "name": "crush_0.8.2_Darwin_arm64.tar.gz",
30
+ "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.2/crush_0.8.2_Darwin_arm64.tar.gz",
31
31
  "bins": [
32
32
  "crush"
33
33
  ],
34
34
  "format": "tar.gz",
35
35
  "checksum": {
36
36
  "algorithm": "sha256",
37
- "digest": "c3a3125ba8e7e1bc6734a7379093984494547c8cdad41ff914da7e278a66815b"
37
+ "digest": "c4fd98f2081b2ef7cb5042004839438c44a6412d44ec8c8522ed8f8533e8361b"
38
38
  },
39
- "wrappedIn": "crush_0.8.0_Darwin_arm64"
39
+ "wrappedIn": "crush_0.8.2_Darwin_arm64"
40
40
  },
41
41
  "darwin-x64": {
42
- "name": "crush_0.8.0_Darwin_x86_64.tar.gz",
43
- "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.0/crush_0.8.0_Darwin_x86_64.tar.gz",
42
+ "name": "crush_0.8.2_Darwin_x86_64.tar.gz",
43
+ "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.2/crush_0.8.2_Darwin_x86_64.tar.gz",
44
44
  "bins": [
45
45
  "crush"
46
46
  ],
47
47
  "format": "tar.gz",
48
48
  "checksum": {
49
49
  "algorithm": "sha256",
50
- "digest": "5ad53607f3c905297dad13f85f0da75267c8607b30a9a816cb3ed9b33094d9fa"
50
+ "digest": "494948f0437a454c7a5c4e16b992f85f5763f599608f64fe12443ce929afbbd7"
51
51
  },
52
- "wrappedIn": "crush_0.8.0_Darwin_x86_64"
52
+ "wrappedIn": "crush_0.8.2_Darwin_x86_64"
53
53
  },
54
54
  "linux-arm64": {
55
- "name": "crush_0.8.0_Linux_arm64.tar.gz",
56
- "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.0/crush_0.8.0_Linux_arm64.tar.gz",
55
+ "name": "crush_0.8.2_Linux_arm64.tar.gz",
56
+ "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.2/crush_0.8.2_Linux_arm64.tar.gz",
57
57
  "bins": [
58
58
  "crush"
59
59
  ],
60
60
  "format": "tar.gz",
61
61
  "checksum": {
62
62
  "algorithm": "sha256",
63
- "digest": "29310aeec73da37d169ba088b0af7431b115412aa02b1bf2253a30b160b1bfc1"
63
+ "digest": "b0e0f8b3a2bf80cd2b17600ddb19e6d98dde86335d754ba19dd983a5970e0eed"
64
64
  },
65
- "wrappedIn": "crush_0.8.0_Linux_arm64"
65
+ "wrappedIn": "crush_0.8.2_Linux_arm64"
66
66
  },
67
67
  "linux-x64": {
68
- "name": "crush_0.8.0_Linux_x86_64.tar.gz",
69
- "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.0/crush_0.8.0_Linux_x86_64.tar.gz",
68
+ "name": "crush_0.8.2_Linux_x86_64.tar.gz",
69
+ "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.2/crush_0.8.2_Linux_x86_64.tar.gz",
70
70
  "bins": [
71
71
  "crush"
72
72
  ],
73
73
  "format": "tar.gz",
74
74
  "checksum": {
75
75
  "algorithm": "sha256",
76
- "digest": "3f6a07972aee41f81ee38b8279784b64f609ad0250b83389fa2fa98fdf429bd7"
76
+ "digest": "87711a747449b603264427f8e034b8235a1ec9979765b0d61690e56c2644cd96"
77
77
  },
78
- "wrappedIn": "crush_0.8.0_Linux_x86_64"
78
+ "wrappedIn": "crush_0.8.2_Linux_x86_64"
79
79
  },
80
80
  "win32-arm64": {
81
- "name": "crush_0.8.0_Windows_arm64.zip",
82
- "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.0/crush_0.8.0_Windows_arm64.zip",
81
+ "name": "crush_0.8.2_Windows_arm64.zip",
82
+ "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.2/crush_0.8.2_Windows_arm64.zip",
83
83
  "bins": [
84
84
  "crush.exe"
85
85
  ],
86
86
  "format": "zip",
87
87
  "checksum": {
88
88
  "algorithm": "sha256",
89
- "digest": "431dbfe2596e732d93b5f807559d9c7e13b94098bd0061626ca2c36bc18ce8aa"
89
+ "digest": "101f5079cfade7c8989628b3c6131b57dbb062a8b7ac3d48b64e5a8927edf0bd"
90
90
  },
91
- "wrappedIn": "crush_0.8.0_Windows_arm64"
91
+ "wrappedIn": "crush_0.8.2_Windows_arm64"
92
92
  },
93
93
  "win32-x64": {
94
- "name": "crush_0.8.0_Windows_x86_64.zip",
95
- "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.0/crush_0.8.0_Windows_x86_64.zip",
94
+ "name": "crush_0.8.2_Windows_x86_64.zip",
95
+ "url": "https://github.com/charmbracelet/crush/releases/download/v0.8.2/crush_0.8.2_Windows_x86_64.zip",
96
96
  "bins": [
97
97
  "crush.exe"
98
98
  ],
99
99
  "format": "zip",
100
100
  "checksum": {
101
101
  "algorithm": "sha256",
102
- "digest": "14df5bfd70437709a7222286769d4723f2166401167aeaf3271fb96d61963387"
102
+ "digest": "a9c17b4c65ed8007da3cf1171ec3e6dfd1b027b42b25869cc305a1427b6711cb"
103
103
  },
104
- "wrappedIn": "crush_0.8.0_Windows_x86_64"
104
+ "wrappedIn": "crush_0.8.2_Windows_x86_64"
105
105
  }
106
106
  }
107
107
  }