Remote Sessions

Remote sessions let you access the same Copilot session from GitHub web and mobile via Mission Control. When enabled, the SDK connects each session to Mission Control and issues a URL that can be shared as a link or QR code. To run the session itself on GitHub-hosted infrastructure instead of locally or on your own server, use Cloud Sessions.

Prerequisites

The user must be authenticated (GitHub token or logged-in user)
The session’s workingDirectory must be a GitHub repository

Always-on (client-level)

When remote: true is set, every session in a GitHub repository automatically gets a remote URL. Rather than hardcoding this in config/copilot.php, a more flexible approach is to enable remote: true only when calling useStdio() for the specific operation that needs it.

The remote option only applies when the SDK spawns the CLI process. It is stdio mode only and is ignored when connecting to an external server via useTcp().

use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Enums\SessionEventType;
use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Support\PermissionHandler;
use Revolution\Copilot\Types\SessionConfig;
use Revolution\Copilot\Types\SessionEvent;

$config = new SessionConfig(
    workingDirectory: '/path/to/github-repo',
    onPermissionRequest: PermissionHandler::approveAll(),
);

$stdioConfig = config('copilot');
$stdioConfig['remote'] = true;

Copilot::useStdio($stdioConfig)->start(function (CopilotSession $session): void {
    $session->on(SessionEventType::SESSION_INFO, function (SessionEvent $event): void {
        if ($event->data('infoType') === 'remote') {
            echo 'Remote URL: '.$event->data('url').PHP_EOL;
        }
    });
}, config: $config);

On-demand (per-session toggle)

To start sharing mid-session, toggle remote access via RPC. This is equivalent to the CLI’s /remote on and /remote off commands.

use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Facades\Copilot;

Copilot::start(function (CopilotSession $session): void {
    $result = $session->rpc()->remote()->enable();

    if ($result->url !== null) {
        echo 'Remote URL: '.$result->url.PHP_EOL;
    }

    // Stop sharing
    $session->rpc()->remote()->disable();
});

Runtime-wide Remote Control (TCP mode)

The remote: true option applies when the SDK spawns the CLI process, so it only works in stdio mode. When you connect to an existing CLI server in TCP mode, Copilot CLI ignores this option. In TCP mode, use $client->rpc()->sessions() to manage a single Remote Control for the whole runtime. Unlike the per-session remote()->enable(), these methods let you start, stop, and transfer Remote Control between sessions, and read its current status.

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\Rpc\RemoteControlConfig;
use Revolution\Copilot\Types\Rpc\SessionsStartRemoteControlRequest;

$client = Copilot::useTcp(url: 'tcp://127.0.0.1:12345')->client();

$result = $client->rpc()->sessions()->startRemoteControl(
    new SessionsStartRemoteControlRequest(
        sessionId: $sessionId,
        config: new RemoteControlConfig(
            remote: true,
            steerable: true,
            explicit: true,
            silent: false,
        ),
    ),
);

if ($result->status->frontendUrl !== null) {
    echo 'Remote URL: '.$result->status->frontendUrl.PHP_EOL;
}

The status is one of off, connecting, active, or error. When the status is active, you can also read frontendUrl and isSteerable.

$status = $client->rpc()->sessions()->getRemoteControlStatus();

$client->rpc()->sessions()->setRemoteControlSteering(['enabled' => true]);
$client->rpc()->sessions()->transferRemoteControl([
    'toSessionId' => $nextSessionId,
    'expectedFromSessionId' => $sessionId,
]);
$client->rpc()->sessions()->stopRemoteControl([
    'expectedSessionId' => $nextSessionId,
]);

To tell the runtime that a session’s remote steerability has changed, use the session-scoped RPC.

$session->rpc()->remote()->notifySteerableChanged(['remoteSteerable' => true]);

QR code generation

Render the remote URL as a QR code for easy mobile access. BaconQrCode, which is also used by Laravel Fortify, works well here.

use BaconQrCode\Renderer\Image\SvgImageBackEnd;
use BaconQrCode\Renderer\ImageRenderer;
use BaconQrCode\Renderer\RendererStyle\RendererStyle;
use BaconQrCode\Writer;

$writer = new Writer(
    new ImageRenderer(
        new RendererStyle(256),
        new SvgImageBackEnd(),
    ),
);

$svg = $writer->writeString($result->url ?? '');

Notes

The remote option only applies when the SDK spawns the CLI process. It is ignored when connecting to an external server via useTcp().
If the working directory is not a GitHub repository, remote setup is silently skipped in always-on mode. In on-demand mode (remote()->enable()), this may return an error.
Ensure authentication is configured correctly (github_token or use_logged_in_user).

GitHub Copilot

SDK

AI SDK

VOICEVOX

Starter Kits

Feeds and RSS

Middleware

Remote Sessions

Remote Sessions

Prerequisites

Always-on (client-level)

On-demand (per-session toggle)

Runtime-wide Remote Control (TCP mode)

QR code generation

Notes

See also

​Remote Sessions

​Prerequisites

​Always-on (client-level)

​On-demand (per-session toggle)

​Runtime-wide Remote Control (TCP mode)

​QR code generation

​Notes

​See also

Remote Sessions

Prerequisites

Always-on (client-level)

On-demand (per-session toggle)

Runtime-wide Remote Control (TCP mode)

QR code generation

Notes

See also