docs: Add note about non-openai providers; add --provider cli flag to the help (#484)
This commit is contained in:
19
README.md
19
README.md
@@ -78,6 +78,25 @@ export OPENAI_API_KEY="your-api-key-here"
|
|||||||
>
|
>
|
||||||
> The CLI will automatically load variables from `.env` (via `dotenv/config`).
|
> The CLI will automatically load variables from `.env` (via `dotenv/config`).
|
||||||
|
|
||||||
|
> **Note:** Codex also allows you to use other providers that support the OpenAI Chat Completions API. You can set the provider in the config file or use the `--provider` flag.
|
||||||
|
>
|
||||||
|
> The possible options for `--provider` are:
|
||||||
|
>
|
||||||
|
> - openai (default)
|
||||||
|
> - openrouter
|
||||||
|
> - gemini
|
||||||
|
> - ollama
|
||||||
|
> - mistral
|
||||||
|
> - deepseek
|
||||||
|
> - xai
|
||||||
|
> - groq
|
||||||
|
>
|
||||||
|
> If you use a provider other than OpenAI, you will need to set the API key for the provider in the config file or in the environment variable as:
|
||||||
|
>
|
||||||
|
> ```shell
|
||||||
|
> export <provider>_API_KEY="your-api-key-here"
|
||||||
|
> ```
|
||||||
|
|
||||||
Run interactively:
|
Run interactively:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
|||||||
@@ -54,6 +54,7 @@ const cli = meow(
|
|||||||
Options
|
Options
|
||||||
-h, --help Show usage and exit
|
-h, --help Show usage and exit
|
||||||
-m, --model <model> Model to use for completions (default: o4-mini)
|
-m, --model <model> Model to use for completions (default: o4-mini)
|
||||||
|
-p, --provider <provider> Provider to use for completions (default: openai)
|
||||||
-i, --image <path> Path(s) to image files to include as input
|
-i, --image <path> Path(s) to image files to include as input
|
||||||
-v, --view <rollout> Inspect a previously saved rollout instead of starting a session
|
-v, --view <rollout> Inspect a previously saved rollout instead of starting a session
|
||||||
-q, --quiet Non-interactive mode that only prints the assistant's final output
|
-q, --quiet Non-interactive mode that only prints the assistant's final output
|
||||||
|
|||||||
Reference in New Issue
Block a user