跳转到主要内容
GitHub Copilot SDK for Laravel 是一个社区 SDK,可以在 Laravel 应用中使用官方 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

use Revolution\Copilot\Facades\Copilot;

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

在一个会话中执行多个 prompt

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() 辅助函数

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());

从这里开始

快速开始

迈出使用 Copilot 的 Laravel 应用的第一步。

认证

配置 GitHub 登录、Token 认证与 BYOK 工作流。

SessionConfig

控制工具、模型、MCP 服务器与会话行为。

SessionEvent

了解 Laravel 特有的事件辅助工具与生命周期处理。

权限请求

查看通过显式批准来执行工具的权限流程。

工具

定义可以从 Copilot 调用的自定义工具。

流式输出

学习如何处理增量输出与实时响应。

MCP

连接 MCP 服务器以扩展功能。

Laravel Cloud

在 Laravel Cloud 环境中运行 SDK。

官方 SDK 兼容层

了解如何从 Laravel 使用与官方 SDK 相同的 bare API。

官方仓库

最后修改于 2026年7月13日