Authentication

The Copilot SDK supports multiple authentication methods. Choose one based on your use case.

Authentication methods

Method	Primary use case	Copilot subscription	Notes
GitHub login (CLI)	Development and manual runs	Required	Uses the login session from the `copilot` CLI
OAuth GitHub App / PAT	Per-user tokens	Required	Set via `github_token`
Environment variables	CI/CD and server runtime	Required	`COPILOT_GITHUB_TOKEN`, etc.
BYOK (Bring Your Own Key)	Your own model provider	Not required	Configure a custom provider

For BYOK, see custom-providers.md. If you are already logged in with copilot or gh CLI, the SDK uses stored credentials by default.

use Revolution\Copilot\Facades\Copilot;

$response = Copilot::run(prompt: 'Hello');

OAuth GitHub App / PAT

Pass a user access token from OAuth, or a fine-grained PAT, to github_token.

Expected token prefixes: gho_, ghu_, github_pat_
ghp_ (classic PAT) is discouraged

use Revolution\Copilot\Facades\Copilot;

$config = array_merge(config('copilot'), [
    'github_token' => $user->github_token,
]);

$response = Copilot::useStdio($config)->run(prompt: '...');
Copilot::stop();

When you set github_token, use_logged_in_user is automatically set to false. To override explicitly:

$config = [
    'github_token' => $user->github_token,
    'use_logged_in_user' => true,
];

For details, see github-token.md. Both github_token and use_logged_in_user are only available in stdio mode. In TCP mode, the Copilot CLI must already be authenticated.

Environment variables

If you pass a token via environment variables, the CLI auto-detects it using this priority order:

COPILOT_GITHUB_TOKEN
GH_TOKEN
GITHUB_TOKEN

COPILOT_GITHUB_TOKEN=github_pat_xxx

use Revolution\Copilot\Facades\Copilot;

$response = Copilot::run(prompt: 'Hello');

In TCP mode, set environment variables on the CLI server side.

Authentication priority

The SDK resolves credentials in this order:

github_token (explicitly provided)
Environment variable tokens (COPILOT_GITHUB_TOKEN → GH_TOKEN → GITHUB_TOKEN)
OAuth credentials stored by CLI
Credentials from gh CLI

If you do not want to use stored credentials, set use_logged_in_user to false.

use Revolution\Copilot\Facades\Copilot;

$response = Copilot::useStdio([
    'use_logged_in_user' => false,
])->run(prompt: 'Hello');

As with github_token, this is supported in stdio mode only. In TCP mode, the Copilot CLI must already be authenticated.

Check authentication status

You can read the result of auth.getStatus.

use Revolution\Copilot\Facades\Copilot;

$status = Copilot::client()->getAuthStatus();

if (! $status->isAuthenticated) {
    // Not authenticated
}

Enumerate loginAccounts through the session RPC to get the stored identities you can reuse with a given provider. Each item’s label is for display, and active indicates whether the identity matches the current session’s active account. accountId is an opaque ID owned by the provider. Pass it to the login request as is, without parsing or modifying it.

use Revolution\Copilot\Enums\AuthLoginMode;
use Revolution\Copilot\Enums\LoginProviderKind;
use Revolution\Copilot\Types\Rpc\AuthLoginBeginRequest;

$accounts = $session->rpc()->accounts();
$identities = $accounts->enumerate(
    'loginAccounts',
    provider: LoginProviderKind::ENTRA,
);

if (isset($identities[0])) {
    $accounts->begin(new AuthLoginBeginRequest(
        kind: LoginProviderKind::ENTRA,
        mode: AuthLoginMode::Default,
        accountId: $identities[0]->accountId,
    ));
}

Use mode: 'default' to reuse a stored identity with the provider’s normal behavior. Use mode: 'selectAccount' to explicitly show the provider’s account picker. In that case, don’t pass accountId. Existing calls such as begin(LoginProviderKind::ENTRA) continue to work.

For the latest updates, see the GitHub repository.

GitHub Copilot

SDK

AI SDK

VOICEVOX

Starter Kits

Feeds and RSS

Middleware

Authentication - GitHub Copilot SDK for Laravel

Authentication

Authentication methods

OAuth GitHub App / PAT

Environment variables

Authentication priority

Check authentication status

​Authentication

​Authentication methods

​GitHub login (CLI)

​OAuth GitHub App / PAT

​Environment variables

​Authentication priority

​Disable automatic login

​Check authentication status

​Select an account for interactive login

Authentication

Authentication methods

GitHub login (CLI)

OAuth GitHub App / PAT

Environment variables

Authentication priority

Disable automatic login

Check authentication status

Select an account for interactive login