認証 - GitHub Copilot SDK for Laravel

Laravel Copilot SDK の認証方式を理解し、ローカル開発・CI・サーバー実行・BYOKに適した方法を選択します。

​

認証

Copilot SDKは複数の認証方法をサポートします。用途に合わせて選択してください。

​

認証方法

方法	主な用途	Copilotサブスクリプション	備考
GitHubログイン（CLI）	開発・手動実行	必要	copilot CLIのログイン情報を利用
OAuth GitHub App / PAT	ユーザーごとのトークン	必要	github_tokenで指定
環境変数	CI/CD・サーバー運用	必要	COPILOT_GITHUB_TOKEN など
BYOK（Bring Your Own Key）	自前のモデルプロバイダー	不要	カスタムプロバイダー設定

BYOKは Custom providers を参照。

​

GitHubログイン（CLI）

copilot もしくは gh CLIでログイン済みの場合は、何も指定しなければ保存済みの認証情報が使われます。

use Revolution\Copilot\Facades\Copilot;

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

​

OAuth GitHub App / PAT

OAuthフローで取得したユーザーアクセストークン、またはFine-grained PATをgithub_tokenに渡します。

• gho_ / ghu_ / github_pat_ を想定
• ghp_（Classic PAT）は非推奨

use Revolution\Copilot\Facades\Copilot;

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

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

github_tokenを指定するとuse_logged_in_userは自動でfalseになります。明示的に切り替えたい場合は次の通り。

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

詳細は GitHub token を参照。 github_tokenとuse_logged_in_userはstdioモード専用です。TCPモードではCopilot CLI側で認証済みである必要があります。

​

環境変数

環境変数でトークンを渡す場合は、CLIが自動的に検出します。優先順位は上から順です。

1. COPILOT_GITHUB_TOKEN
2. GH_TOKEN
3. GITHUB_TOKEN

COPILOT_GITHUB_TOKEN=github_pat_xxx

use Revolution\Copilot\Facades\Copilot;

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

TCPモードではCLIサーバー側の環境変数を設定してください。

​

認証の優先順位

SDKは以下の順で認証情報を解決します。

1. github_token（明示指定）
2. 環境変数トークン（COPILOT_GITHUB_TOKEN → GH_TOKEN → GITHUB_TOKEN）
3. CLIに保存されたOAuth認証情報
4. gh CLIの認証情報

​

自動ログインを無効化

保存済みの認証情報を使いたくない場合はuse_logged_in_userをfalseにします。

use Revolution\Copilot\Facades\Copilot;

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

github_tokenと同様にstdioモードのみ対応です。TCPモードではCopilot CLI側で認証済みである必要があります。

​

認証状態の確認

auth.getStatusの結果を取得して確認できます。

use Revolution\Copilot\Facades\Copilot;

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

if (! $status->isAuthenticated) {
    // 未認証
}

最新情報は GitHub リポジトリ を参照してください。