@@ -157,8 +157,8 @@ Configuration itself is stored as a JSON object:
```json
{
- "this-setting": {"this": "that"},
- "that-setting": ["ceci", "cela"]
+ "this-setting": { "this": "that" },
+ "that-setting": ["ceci", "cela"]
}
```
@@ -390,9 +390,9 @@ Custom Anthropic-compatible providers follow this format:
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`
+- 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
@@ -428,17 +428,6 @@ To add specific models to the configuration, configure as such:
}
```
-## 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
@@ -470,14 +459,20 @@ config:
}
```
-## Disabling providers auto-update
+## Disabling Provider Auto-Updates
-Crush automatically fetches the updated list of providers and models from
-[Catwalk](https://github.com/charmbracelet/catwalk). We know some environments
-have restricted internet access, so if you need to disable this you have two
-options:
+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.
-Set `disable_provider_auto_update` into your `crush.json` config:
+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
{
@@ -488,15 +483,16 @@ Set `disable_provider_auto_update` into your `crush.json` config:
}
```
-Or alternatively set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment
-variable:
+Or set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment variable:
```bash
export CRUSH_DISABLE_PROVIDER_AUTO_UPDATE=1
```
-With that set, you'll have to manually update providers from time to time. It's
-possible to do that with the `crush update-providers` command:
+### Manually updating providers
+
+Manually updating providers is possible with the `crush update-providers`
+command:
```bash
# Update providers remotely from Catwalk.
@@ -508,11 +504,24 @@ crush update-providers https://example.com/
# Update providers from a local file.
crush update-providers /path/to/local-providers.json
-# Update providers from the embedded version.
-# (Crush ships with an embedded copy of Catwalk on the time of the release).
+# Reset providers to the embedded version, embedded at crush at build time.
crush update-providers embedded
+
+# For more info:
+crush update-providers --help
```
+## 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 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).
+
## Whatcha think?
We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on: