Configuración predeterminada (CLI agrupada)

Lo mejor para: La mayoría de las aplicaciones: aplicaciones de escritorio, herramientas independientes, utilidades de la CLI, prototipos y mucho más.

Cómo funciona

Al instalar el SDK, el binario de la CLI de Copilot se incluye automáticamente. El SDK lo inicia como un proceso secundario y se comunica a través de stdio. No hay nada adicional para configurar.

Características principales:

• El binario de la CLI se incluye con el SDK: no se necesita ninguna instalación independiente.
• El SDK administra la versión de la CLI para garantizar la compatibilidad.
• Los usuarios se autentican a través de la aplicación (o usan env vars/BYOK)
• Las sesiones se administran por usuario en su máquina

Inicio rápido

import { CopilotClient } from "@github/copilot-sdk";

const client = new CopilotClient();

const session = await client.createSession({ model: "gpt-4.1" });
const response = await session.sendAndWait({ prompt: "Hello!" });
console.log(response?.data.content);

await client.stop();

from copilot import CopilotClient
from copilot.session import PermissionHandler

client = CopilotClient()
await client.start()

session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-4.1")
response = await session.send_and_wait("Hello!")
print(response.data.content)

await client.stop()

package main

import (
    "context"
    "fmt"
    "log"
    copilot "github.com/github/copilot-sdk/go"
)

func main() {
    ctx := context.Background()

    client := copilot.NewClient(nil)
    if err := client.Start(ctx); err != nil {
        log.Fatal(err)
    }
    defer client.Stop()

    session, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-4.1"})
    response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: "Hello!"})
    if d, ok := response.Data.(*copilot.AssistantMessageData); ok {
        fmt.Println(d.Content)
    }
}

client := copilot.NewClient(nil)
if err := client.Start(ctx); err != nil {
    log.Fatal(err)
}
defer client.Stop()

session, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-4.1"})
response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: "Hello!"})
if d, ok := response.Data.(*copilot.AssistantMessageData); ok {
    fmt.Println(d.Content)
}

await using var client = new CopilotClient();
await using var session = await client.CreateSessionAsync(
    new SessionConfig { Model = "gpt-4.1" });

var response = await session.SendAndWaitAsync(
    new MessageOptions { Prompt = "Hello!" });
Console.WriteLine(response?.Data.Content);

import com.github.copilot.CopilotClient;
import com.github.copilot.rpc.*;

var client = new CopilotClient(new CopilotClientOptions()
    // Point to the CLI binary installed on the system
    .setCliPath("/path/to/vendor/copilot")
);
client.start().get();

var session = client.createSession(new SessionConfig()
    .setModel("gpt-4.1")
    .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
).get();

var response = session.sendAndWait(new MessageOptions()
    .setPrompt("Hello!")).get();
System.out.println(response.getData().content());

client.stop().get();

Estrategias de autenticación

Debe decidir cómo se autenticarán los usuarios. Estos son los patrones comunes:

Opción A: credenciales de inicio de sesión del usuario (más sencilla)

El usuario inicia sesión en la CLI una vez y la aplicación usa esas credenciales. No se necesita código adicional: este es el comportamiento predeterminado.

const client = new CopilotClient();
// Default: uses signed-in user credentials

Opción B: testigo mediante una variable de entorno

Envíe la aplicación con instrucciones para establecer un token o establecerla mediante programación:

const client = new CopilotClient({
    env: {
        COPILOT_GITHUB_TOKEN: getUserToken(),  // Your app provides the token
    },
});

Opción C: BYOK (sin autenticación GitHub necesaria)

Si gestionas tus propias claves de proveedor de modelos, los usuarios no necesitan cuentas de GitHub en absoluto:

const client = new CopilotClient();

const session = await client.createSession({
    model: "gpt-4.1",
    provider: {
        type: "openai",
        baseUrl: "https://api.openai.com/v1",
        apiKey: process.env.OPENAI_API_KEY,
    },
});

Consulte BYOK (traiga su propia clave) para obtener más información.

Administración de sesiones

Las aplicaciones suelen querer sesiones con nombre para que los usuarios puedan reanudar conversaciones:

const client = new CopilotClient();

// Create a session tied to the user's project
const sessionId = `project-${projectName}`;
const session = await client.createSession({
    sessionId,
    model: "gpt-4.1",
});

// User closes app...
// Later, resume where they left off
const resumed = await client.resumeSession(sessionId);

El estado de sesión persiste en ~/.copilot/session-state/{sessionId}/.

Cuándo seguir adelante

Pasos siguientes

• BYOK (traiga su propia clave): Usa las claves de tu proveedor de modelos
• Reanudación y persistencia de sesión: Administración avanzada de sesiones
• Crea tu primera aplicación con tecnología Copilot: Compilación de una aplicación completa