> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub Copilot SDK for Laravel

> 了解 Laravel Copilot SDK 提供的功能，並前往設定、session、工具、執行時期組態的主要指南。

GitHub Copilot SDK for Laravel 是一款社群 SDK，讓官方 [GitHub Copilot SDK](https://github.com/github/copilot-sdk) 的工作流程能在 Laravel 應用程式中使用。

可從 Artisan 指令、controller、job 等 Laravel 各種執行情境呼叫 Copilot。

## Laravel 專屬要點

本套件在 SDK 相容層之上，加入了 Laravel 原生的使用體驗。

* 以 `Copilot::run()` 與 `Copilot::start()` 為核心的 Facade 型 API
* 使用 `config/copilot.php` 與 `.env` 的 Laravel 風格設定
* 與 Laravel Prompts、queue、console UX 的整合切入點
* `Copilot::fake()` 與 prompt 斷言等測試工具

## 使用範例

### 執行單一 prompt

```php theme={null}
use Revolution\Copilot\Facades\Copilot;

$response = Copilot::run(prompt: 'Tell me something about Laravel.');
dump($response->content());
```

### 於同一 session 中執行多個 prompt

```php theme={null}
use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Facades\Copilot;

$content = Copilot::start(function (CopilotSession $session) {
    dump('Starting Copilot session: '.$session->id());

    $response = $session->sendAndWait(prompt: 'Tell me something about PHP.');
    dump($response->content());

    $response = $session->sendAndWait(prompt: 'Tell me something about Laravel.');
    dump($response->content());

    return $response->content();
});

dump($content);
```

### `copilot()` 輔助函式

```php theme={null}
use Revolution\Copilot\Contracts\CopilotSession;
use function Revolution\Copilot\copilot;

// 指定 prompt 時等同於 Copilot::run()
$response = copilot('Tell me something about Laravel.');

// 指定閉包時等同於 Copilot::start()
copilot(function (CopilotSession $session) {
    $response = $session->sendAndWait(prompt: 'Tell me something about PHP.');
});

// 未傳任何參數時等同於 Facade
dump(copilot()->client()->ping());
```

## 從這裡開始

<Columns cols={2}>
  <Card title="開始使用" href="/zh-TW/packages/laravel-copilot-sdk/getting-started">
    邁出使用 Copilot 的 Laravel 應用程式的第一步。
  </Card>

  <Card title="認證" href="/zh-TW/packages/laravel-copilot-sdk/auth">
    設定 GitHub 登入、token 認證、BYOK 工作流程。
  </Card>

  <Card title="SessionConfig" href="/zh-TW/packages/laravel-copilot-sdk/session-config">
    控制工具、模型、MCP 伺服器與 session 行為。
  </Card>

  <Card title="SessionEvent" href="/zh-TW/packages/laravel-copilot-sdk/session-event">
    了解 Laravel 專屬的事件輔助工具與生命週期處理。
  </Card>

  <Card title="權限請求" href="/zh-TW/packages/laravel-copilot-sdk/permission-request">
    確認以明確授權執行工具的權限流程。
  </Card>

  <Card title="工具" href="/zh-TW/packages/laravel-copilot-sdk/tools">
    定義可從 Copilot 呼叫的自訂工具。
  </Card>

  <Card title="串流" href="/zh-TW/packages/laravel-copilot-sdk/streaming">
    學習漸進式輸出與即時回應的處理方式。
  </Card>

  <Card title="MCP" href="/zh-TW/packages/laravel-copilot-sdk/mcp">
    連接 MCP 伺服器以擴充功能。
  </Card>

  <Card title="Laravel Cloud" href="/zh-TW/packages/laravel-copilot-sdk/laravel-cloud">
    於 Laravel Cloud 環境執行 SDK。
  </Card>

  <Card title="官方 SDK 相容層" href="/zh-TW/packages/laravel-copilot-sdk/bare-usage">
    確認如何在 Laravel 中使用與官方 SDK 相同的 bare API。
  </Card>
</Columns>

## 官方儲存庫

* Laravel 套件：[invokable/laravel-copilot-sdk](https://github.com/invokable/laravel-copilot-sdk)
* 官方 SDK：[github/copilot-sdk](https://github.com/github/copilot-sdk)


## Related topics

- [GitHub Actions - GitHub Copilot SDK for Laravel](/zh-TW/packages/laravel-copilot-sdk/github-actions.md)
- [測試 - GitHub Copilot SDK for Laravel](/zh-TW/packages/laravel-copilot-sdk/fake.md)
- [認證 - GitHub Copilot SDK for Laravel](/zh-TW/packages/laravel-copilot-sdk/auth.md)
- [Laravel Cloud - GitHub Copilot SDK for Laravel](/zh-TW/packages/laravel-copilot-sdk/laravel-cloud.md)
- [開始使用 - GitHub Copilot SDK for Laravel](/zh-TW/packages/laravel-copilot-sdk/getting-started.md)