> ## 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 提供的内容，并前往安装、会话、工具与运行时配置的主要指南。

GitHub Copilot SDK for Laravel 是一个社区 SDK，可以在 Laravel 应用中使用官方 [GitHub Copilot SDK](https://github.com/github/copilot-sdk) 的工作流。

你可以从 Artisan 命令、控制器、任务等各种 Laravel 执行上下文中调用 Copilot。

## Laravel 特有的要点

这个包在 SDK 兼容层之上添加了 Laravel 原生的使用体验。

* 以 `Copilot::run()` 和 `Copilot::start()` 为中心的基于 Facade 的 API
* 使用 `config/copilot.php` 和 `.env` 的 Laravel 风格配置
* 与 Laravel Prompts、队列、控制台 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());
```

### 在一个会话中执行多个 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/packages/laravel-copilot-sdk/getting-started">
    迈出使用 Copilot 的 Laravel 应用的第一步。
  </Card>

  <Card title="认证" href="/zh/packages/laravel-copilot-sdk/auth">
    配置 GitHub 登录、Token 认证与 BYOK 工作流。
  </Card>

  <Card title="SessionConfig" href="/zh/packages/laravel-copilot-sdk/session-config">
    控制工具、模型、MCP 服务器与会话行为。
  </Card>

  <Card title="SessionEvent" href="/zh/packages/laravel-copilot-sdk/session-event">
    了解 Laravel 特有的事件辅助工具与生命周期处理。
  </Card>

  <Card title="权限请求" href="/zh/packages/laravel-copilot-sdk/permission-request">
    查看通过显式批准来执行工具的权限流程。
  </Card>

  <Card title="工具" href="/zh/packages/laravel-copilot-sdk/tools">
    定义可以从 Copilot 调用的自定义工具。
  </Card>

  <Card title="流式输出" href="/zh/packages/laravel-copilot-sdk/streaming">
    学习如何处理增量输出与实时响应。
  </Card>

  <Card title="MCP" href="/zh/packages/laravel-copilot-sdk/mcp">
    连接 MCP 服务器以扩展功能。
  </Card>

  <Card title="Laravel Cloud" href="/zh/packages/laravel-copilot-sdk/laravel-cloud">
    在 Laravel Cloud 环境中运行 SDK。
  </Card>

  <Card title="官方 SDK 兼容层" href="/zh/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 Copilot SDK for Laravel](/en/packages/laravel-copilot-sdk/index.md)