Skip to content

docs: codex subscription support #7104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dianed-square merged 3 commits into from
Feb 10, 2026
Merged

docs: codex subscription support #7104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4503be1
codex subscription support
dianed-square Feb 10, 2026
ffe0220
add links
dianed-square Feb 10, 2026
82fc05f
setup info
dianed-square Feb 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 25 additions & 9 deletions documentation/docs/getting-started/providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ goose is compatible with a wide range of LLM providers, allowing you to choose a
| [Amazon SageMaker TGI](https://docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints.html) | Run Text Generation Inference models through Amazon SageMaker endpoints. **AWS credentials must be configured in advance.** | `SAGEMAKER_ENDPOINT_NAME`, `AWS_REGION` (optional), `AWS_PROFILE` (optional) |
| [Anthropic](https://www.anthropic.com/) | Offers Claude, an advanced AI model for natural language tasks. | `ANTHROPIC_API_KEY`, `ANTHROPIC_HOST` (optional) |
| [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/) | Access Azure-hosted OpenAI models, including GPT-4 and GPT-3.5. Supports both API key and Azure credential chain authentication. | `AZURE_OPENAI_ENDPOINT`, `AZURE_OPENAI_DEPLOYMENT_NAME`, `AZURE_OPENAI_API_KEY` (optional) |
| [ChatGPT Codex](https://chatgpt.com/codex) | Access GPT-5 Codex models optimized for code generation and understanding. **Requires a ChatGPT Plus/Pro subscription.** | No manual key. Uses browser-based OAuth authentication for both CLI and Desktop. |
Copy link

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This adds ChatGPT Codex as a supported provider, but later in this same doc the “On the welcome screen…” section still says there are only three first-time setup options (Tetrate/OpenRouter/Other Providers), which now contradicts the actual onboarding flow (API Key + ChatGPT Subscription are also shown). Please update that later onboarding section to match the current 5-option welcome screen so readers don’t get misled during setup.

Copilot uses AI. Check for mistakes.
Copy link
Contributor

@blackgirlbytes blackgirlbytes Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why does it say this? it looks like you already updated the welcome screen part. Am i wrong @dianed-square

Copy link
Contributor Author

@dianed-square dianed-square Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have setup info in this topic too

| [Databricks](https://www.databricks.com/) | Unified data analytics and AI platform for building and deploying models. | `DATABRICKS_HOST`, `DATABRICKS_TOKEN` |
| [Docker Model Runner](https://docs.docker.com/ai/model-runner/) | Local models running in Docker Desktop or Docker CE with OpenAI-compatible API endpoints. **Because this provider runs locally, you must first [download a model](#local-llms).** | `OPENAI_HOST`, `OPENAI_BASE_PATH` |
| [Gemini](https://ai.google.dev/gemini-api/docs) | Advanced LLMs by Google with multimodal capabilities (text, images). | `GOOGLE_API_KEY` |
Expand Down Expand Up @@ -70,26 +71,41 @@ To configure your chosen provider, see available options, or select a model, vis
<TabItem value="ui" label="goose Desktop" default>
**First-time users:**

On the welcome screen the first time you open goose, you have three options:
- **Automatic setup with [Tetrate Agent Router](https://tetrate.io/products/tetrate-agent-router-service)**
- **Automatic Setup with [OpenRouter](https://openrouter.ai/)**
- **Other Providers**
On the welcome screen the first time you open goose, you have these options:
- **Quick Setup with API Key** - goose will automatically configure your provider based on your API key
- **[ChatGPT Subscription](https://chatgpt.com/codex)** - Sign in with your ChatGPT Plus/Pro credentials to access GPT-5 Codex models
- **[Agent Router by Tetrate](https://tetrate.io/products/tetrate-agent-router-service)** - Access multiple AI models with automatic setup
- **[OpenRouter](https://openrouter.ai/)** - Access 200+ models with one API using pay-per-use pricing
- **Other Providers** - Manually configure additional providers through settings
<Tabs groupId="setup">
<TabItem value="tetrate" label="Tetrate Agent Router" default>
We recommend starting with Tetrate Agent Router. Tetrate provides access to multiple AI models with built-in rate limiting and automatic failover.
<TabItem value="apikey" label="Quick Setup" default>
1. Choose `Quick Setup with API Key`.
2. Enter your API key from your provider (for example, OpenAI, Anthropic, or Google).
3. goose will automatically detect your provider and configure the connection.
4. When setup is complete, you're ready to begin your first session.
</TabItem>

<TabItem value="chatgpt" label="ChatGPT Subscription">
1. Choose `ChatGPT Subscription`.
2. goose will open a browser window for you to sign in with the credentials of your active ChatGPT Plus or Pro subscription.
3. Authorize goose to access your ChatGPT subscription.
4. When you return to goose Desktop, you're ready to begin your first session.
</TabItem>
<TabItem value="tetrate" label="Agent Router">
We recommend new users start with Agent Router by Tetrate. Tetrate provides access to multiple AI models with built-in rate limiting and automatic failover.

:::info Free Credits Offer
You'll receive $10 in free credits the first time you automatically authenticate with Tetrate through goose. This offer is available to both new and existing Tetrate users.
:::
1. Choose `Automatic setup with Tetrate Agent Router`.
1. Choose `Agent Router by Tetrate`.
2. goose will open a browser window for you to authenticate with Tetrate, or create a new account if you don't have one already.
3. When you return to the goose desktop app, you're ready to begin your first session.
3. When you return to goose Desktop, you're ready to begin your first session.
</TabItem>

<TabItem value="openrouter" label="OpenRouter">
1. Choose `Automatic setup with OpenRouter`.
2. goose will open a browser window for you to authenticate with OpenRouter, or create a new account if you don't have one already.
3. When you return to the goose desktop app, you're ready to begin your first session.
3. When you return to the goose Desktop, you're ready to begin your first session.
</TabItem>

<TabItem value="others" label="Other Providers">
Expand Down
26 changes: 14 additions & 12 deletions documentation/docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,14 @@ goose works with [supported LLM providers](/docs/getting-started/providers) that

<Tabs groupId="interface">
<TabItem value="ui" label="goose Desktop" default>
On the welcome screen, you have three options:
- **Automatic setup with [Tetrate Agent Router](https://tetrate.io/products/tetrate-agent-router-service)**
- **Automatic Setup with [OpenRouter](https://openrouter.ai/)**
- **Other Providers**

For this quickstart, choose `Automatic setup with Tetrate Agent Router`. Tetrate provides access to multiple AI models with built-in rate limiting and automatic failover. For more information about OpenRouter or other providers, see [Configure LLM Provider](/docs/getting-started/providers).
On the welcome screen, you have these options:
- **Quick Setup with API Key** - goose will automatically configure your provider based on your API key
- **[ChatGPT Subscription](https://chatgpt.com/codex)** - Sign in with your ChatGPT Plus/Pro credentials to access GPT-5 Codex models
- **[Agent Router by Tetrate](https://tetrate.io/products/tetrate-agent-router-service)** - Access multiple AI models with automatic setup
- **[OpenRouter](https://openrouter.ai/)** - Access 200+ models with one API using pay-per-use pricing
- **Other Providers** - Manually configure additional providers through settings

For this quickstart, choose **Agent Router by Tetrate**. Tetrate provides access to multiple AI models with built-in rate limiting and automatic failover. For more information about other providers, see [Configure LLM Provider](/docs/getting-started/providers).

goose will open a browser for you to authenticate with Tetrate, or create a new account if you don't have one already. When you return to the goose desktop app, you're ready to begin your first session.

Expand Down Expand Up @@ -157,13 +159,13 @@ goose works with [supported LLM providers](/docs/getting-started/providers) that
│ Configure Providers
│
◆ Which model provider should we use?
│ ○ Anthropic
│ ○ Azure OpenAI
│ ○ Amazon Bedrock
│ ○ Claude Code
│ ○ Codex CLI
│ ○ Databricks
│ ○ Gemini CLI
│ ○ Amazon SageMaker TGI
│ ○ Anthropic
│ ○ Azure OpenAI
│ ○ ChatGPT Codex
│ ○ Claude Code CLI
│ ○ ...
| ● Tetrate Agent Router Service (Enterprise router for AI models)
│ ○ ...
└
Expand Down
Loading