8c0d7b6 · crush · git.iko.soy

git.iko.soy/crush

on main help sign in

docs(readme): copyedits to provider disabling section

8c0d7b6Christian Rocha1 year ago

README.md+37−28

compare with main

unifiedsplit

@@ -157,8 +157,8 @@ Configuration itself is stored as a JSON object:

157

158```json

159{

160− "this-setting": {"this": "that"},

160+ "this-setting": { "this": "that" },

161− "that-setting": ["ceci", "cela"]

161+ "that-setting": ["ceci", "cela"]

162}

163```

164

@@ -390,9 +390,9 @@ Custom Anthropic-compatible providers follow this format:

390

391Crush currently supports running Anthropic models through Bedrock, with caching disabled.

392

393−* A Bedrock provider will appear once you have AWS configured, i.e. `aws configure`

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

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`

395+- To use a specific AWS profile set `AWS_PROFILE` in your environment, i.e. `AWS_PROFILE=myprofile crush`

396

397### Vertex AI Platform

398

@@ -428,17 +428,6 @@ To add specific models to the configuration, configure as such:

428}

429```

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## Logging

431## Logging

443

432

444Sometimes you need to look at logs. Luckily, Crush logs all sorts of

433Sometimes 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

464+By default, Crush automatically checks for the latest and greatest list of

476−[Catwalk](https://github.com/charmbracelet/catwalk). We know some environments

465+providers and models from [Catwalk](https://github.com/charmbracelet/catwalk),

477−have restricted internet access, so if you need to disable this you have two

466+the open source Crush provider database. This means that when new providers and

478−options:

467+models are available, or when model metadata changes, Crush automatically

468+updates your local configuration.

479

469

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+

480−Set `disable_provider_auto_update` into your `crush.json` config:

474+To disable automatic provider updates, set `disable_provider_auto_update` into

475+your `crush.json` config:

481

476

482```json

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

486+Or set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment variable:

492−variable:

493

487

494```bash

488```bash

495export CRUSH_DISABLE_PROVIDER_AUTO_UPDATE=1

489export 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

492+### Manually updating providers

493+

499−possible to do that with the `crush update-providers` command:

494+Manually updating providers is possible with the `crush update-providers`

495+command:

500

496

501```bash

497```bash

502# Update providers remotely from Catwalk.

498# Update providers remotely from Catwalk.

@@ -508,11 +504,24 @@ crush update-providers https://example.com/

508# Update providers from a local file.

504# Update providers from a local file.

509crush update-providers /path/to/local-providers.json

505crush update-providers /path/to/local-providers.json

510

506

511−# Update providers from the embedded version.

507+# Reset providers to the embedded version, embedded at crush at build time.

512−# (Crush ships with an embedded copy of Catwalk on the time of the release).

513crush update-providers embedded

508crush 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## Whatcha think?

525## Whatcha think?

517

526

518We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on:

527We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on: