Skip to content
⚗️ Crucible

GitHub Copilot Setup

This guide walks you through setting up GitHub Copilot as an LLM provider in Crucible.

Prerequisites

Section titled “Prerequisites”
  • Active GitHub Copilot subscription (Individual, Business, or Enterprise)
  • Crucible CLI installed

User Story

Section titled “User Story”

As a Crucible user with a GitHub Copilot subscription, I want to use my existing Copilot access for chat completions, So that I can leverage models like GPT-4o without additional API costs.

Setup Flow

Section titled “Setup Flow”

Step 1: Initiate Device Flow Authentication

Section titled “Step 1: Initiate Device Flow Authentication”

Run the Crucible auth command:

Terminal window
cru auth copilot

This starts the OAuth device flow and displays:

To authenticate with GitHub Copilot:
1. Visit: https://github.com/login/device
2. Enter code: ABCD-1234
3. Authorize the application


Waiting for authorization...

Step 2: Authorize in Browser

Section titled “Step 2: Authorize in Browser”
  1. Open https://github.com/login/device in your browser
  2. Enter the code shown in your terminal
  3. Click “Authorize” when prompted
  4. You’ll see “Congratulations, you’re all set!”

Step 3: Token Storage

Section titled “Step 3: Token Storage”

Once authorized, Crucible stores your OAuth token in the credential store at ~/.config/crucible/secrets.toml. The CLI confirms:

✓ GitHub Copilot authenticated successfully!
  Token stored in /home/user/.config/crucible/secrets.toml

That’s it — no manual configuration needed. Crucible automatically resolves the token from the credential store when you use the Copilot provider.

Step 4: Configure Provider

Section titled “Step 4: Configure Provider”

Add to your crucible.toml:

[llm]
default = "copilot"


[llm.providers.copilot]
type = "copilot"
# No api_key needed — token is resolved from credential store
# default_model = "gpt-4o"  # optional, gpt-4o is default

Alternatively, you can set the token via environment variable (overrides credential store):

Terminal window
export GITHUB_COPILOT_OAUTH_TOKEN="gho_xxxxxxxxxxxx"

Re-authentication

Section titled “Re-authentication”

If you need to re-authenticate (e.g., after revoking the token), use the --force flag:

Terminal window
cru auth copilot --force

This bypasses the existing token check and starts a fresh device flow.

Token Resolution Order

Section titled “Token Resolution Order”

Crucible resolves the Copilot OAuth token in this order:

  1. Environment variable (GITHUB_COPILOT_OAUTH_TOKEN) — highest priority
  2. Credential store (~/.config/crucible/secrets.toml) — set by cru auth copilot
  3. Config api_key — fallback for manual token management

Available Models

Section titled “Available Models”

List models available through your Copilot subscription:

Terminal window
cru models --provider copilot

Typical models include:

  • gpt-4o - Default, best for general use
  • gpt-4o-mini - Faster, lower cost
  • claude-3.5-sonnet - Available on some plans

How It Works

Section titled “How It Works”
┌─────────────┐     ┌─────────────┐     ┌──────────────────┐
│   Crucible  │────▶│   GitHub    │────▶│  GitHub Copilot  │
│     CLI     │     │    OAuth    │     │       API        │
└─────────────┘     └─────────────┘     └──────────────────┘
       │                   │                     │
       │ 1. Device flow    │                     │
       │────────────────▶  │                     │
       │                   │                     │
       │ 2. User authorizes│                     │
       │   (in browser)    │                     │
       │                   │                     │
       │ 3. OAuth token    │                     │
       │◀────────────────  │                     │
       │   (gho_xxx)       │                     │
       │                   │                     │
       │ 4. Exchange for   │                     │
       │    API token      │─────────────────────▶│
       │                   │                     │
       │ 5. API token      │                     │
       │◀────────────────  │◀────────────────────│
       │   (30min TTL)     │                     │
       │                   │                     │
       │ 6. Chat request   │                     │
       │─────────────────────────────────────────▶│

Token Lifecycle

Section titled “Token Lifecycle”
  • OAuth token (gho_xxx): Long-lived, stored in credential store
  • API token: 30-minute TTL, auto-refreshed by Crucible

You only need to re-authenticate if:

  • You revoke the OAuth token in GitHub settings
  • Your Copilot subscription lapses

Checking Stored Credentials

Section titled “Checking Stored Credentials”

View your stored credentials with:

Terminal window
cru auth list

This shows all configured providers and their token sources. OAuth tokens appear with an oauth label and are masked for security (e.g., gho_1****).

Troubleshooting

Section titled “Troubleshooting”

”Access denied” during authorization

Section titled “”Access denied” during authorization”

Your GitHub account may not have an active Copilot subscription. Check: https://github.com/settings/copilot

”Token exchange failed”

Section titled “”Token exchange failed””

The OAuth token may have been revoked. Re-authenticate:

Terminal window
cru auth copilot --force

“Verification code expired”

Section titled ““Verification code expired””

The device code has a limited lifetime. If it expires before you authorize, run cru auth copilot again to get a fresh code.

API errors after working previously

Section titled “API errors after working previously”

The API token (30-min TTL) refreshes automatically, but if issues persist:

  1. Check Copilot status: https://www.githubstatus.com/
  2. Verify subscription is active
  3. Re-authenticate with cru auth copilot --force

Security Notes

Section titled “Security Notes”

See Also

Section titled “See Also”