docs: reword away from 'backend' instead of whitelisting it (mara, #4146)
mara disagreed with exempting this section from #4041's ruling. 'Backend' here meant 'which LLM API provider', and the doc already uses 'provider' for the same concept a few lines down ('provider- specific model string') - so reword to that instead of carving out an exception. Drops the inline vale suppression comment entirely.
This commit is contained in:
parent
397c0a9c7a
commit
3ca81d388c
1 changed files with 3 additions and 11 deletions
|
|
@ -240,13 +240,7 @@ It leaves non-compile subcommands (`new`, `add`, third-party
|
||||||
Set to `false` for agents that parse cargo's JSON output
|
Set to `false` for agents that parse cargo's JSON output
|
||||||
programmatically and don't pass `--message-format json` themselves.
|
programmatically and don't pass `--message-format json` themselves.
|
||||||
|
|
||||||
<!-- vale Microsoft.Avoid = NO -->
|
## API-key provider (`useApiKey` / `backendEnvironmentFile`)
|
||||||
<!-- "backend" here means "which LLM API provider" (a genuinely pluggable
|
|
||||||
choice, matching the nix option's own name `backendEnvironmentFile`) —
|
|
||||||
not one internal system to name instead, so mara's #4041 ruling doesn't
|
|
||||||
apply to this section. -->
|
|
||||||
|
|
||||||
## API-key backend (`useApiKey` / `backendEnvironmentFile`)
|
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
hyperhive.useApiKey = true; # default: false
|
hyperhive.useApiKey = true; # default: false
|
||||||
|
|
@ -255,7 +249,7 @@ hyperhive.backendEnvironmentFile =
|
||||||
hyperhive.model = "anthropic/claude-3.5-sonnet"; # provider-specific model string
|
hyperhive.model = "anthropic/claude-3.5-sonnet"; # provider-specific model string
|
||||||
```
|
```
|
||||||
|
|
||||||
Runs this agent's `claude` against an API-key backend (for example OpenRouter)
|
Runs this agent's `claude` against an API-key provider (for example OpenRouter)
|
||||||
instead of a Claude subscription via OAuth. Two options, paired — each
|
instead of a Claude subscription via OAuth. Two options, paired — each
|
||||||
is a no-op without the other:
|
is a no-op without the other:
|
||||||
|
|
||||||
|
|
@ -305,6 +299,4 @@ Switching an already-provisioned OAuth agent to `useApiKey` leaves
|
||||||
`~/.claude/credentials.json` in place but unused — harmless, not
|
`~/.claude/credentials.json` in place but unused — harmless, not
|
||||||
cleaned up automatically. Cost shape also changes: subscription pricing
|
cleaned up automatically. Cost shape also changes: subscription pricing
|
||||||
→ per-request billing with no built-in monthly cap, worth knowing before
|
→ per-request billing with no built-in monthly cap, worth knowing before
|
||||||
pointing a busy agent at a metered backend.
|
pointing a busy agent at a metered provider.
|
||||||
|
|
||||||
<!-- vale Microsoft.Avoid = YES -->
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue