remote-sessions.md

Remote sessions

Session history can be exported to GitHub web and mobile via Mission Control. This is read-only history export, not remote control of the SDK session.

For running sessions on GitHub-hosted compute, see Cloud Sessions.

Prerequisites

• The user must be authenticated (GitHub token or logged-in user)
• The session's working directory must be a GitHub repository

Enabling remote sessions

On-demand (per-session toggle)

Use the experimental raw session.rpc.remote.enable() API to start history export mid-session, and session.rpc.remote.disable() to stop it. These APIs do not enable AHP connections or remote steering.

TypeScript

const result = await session.rpc.remote.enable();
console.log("Remote URL:", result.url);

// Later: stop sharing
await session.rpc.remote.disable();

Python

result = await session.rpc.remote.enable()
print(f"Remote URL: {result.url}")

# Later: stop sharing
await session.rpc.remote.disable()

Go

result, err := session.RPC.Remote.Enable(ctx)
if result.URL != nil {
    fmt.Println("Remote URL:", *result.URL)
}

// Later: stop sharing
err = session.RPC.Remote.Disable(ctx)

C#

var result = await session.Rpc.Remote.EnableAsync();
Console.WriteLine($"Remote URL: {result.Url}");

// Later: stop sharing
await session.Rpc.Remote.DisableAsync();

Rust

let result = session.rpc().remote().enable().await?;
if let Some(url) = &result.url {
    println!("Remote URL: {url}");
}

// Later: stop sharing
session.rpc().remote().disable().await?;

QR code generation

The remote URL can be rendered as a QR code for easy mobile access. The SDK provides the URL—use your preferred QR code library:

• TypeScript: qrcode
• Python: qrcode
• Go: go-qrcode
• C#: QRCoder
• Rust: qrcode

Notes

• If the working directory is not a GitHub repository, on-demand export returns an error.
• Remote sessions require authentication. Ensure gitHubToken or useLoggedInUser is configured.