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

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

Características principales:

• CLI de Copilot se incluye con : SDK de Copilotno se necesita ninguna instalación independiente.
• SDK de Copilot 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();

Para obtener ejemplos en Python, Go, .NET y Java, consulte Configuración predeterminada en el repositorio de github/copilot-sdk. Para Java, consulte el github/copilot-sdk-java repositorio.

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 una CLI de Copilot 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 GitHub autenticación necesaria)

Si gestiona sus propias claves de su proveedor de modelos, los usuarios no necesitan tener en absoluto cuentas GitHub:

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 Bring Your Own Key (BYOK) 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

Requisito	Guía siguiente
Usuarios que inician sesión con GitHub cuentas
Uso de OAuth de GitHub con el SDK de Copilot
Ejecución en un servidor en lugar de máquinas de usuario
Configuración del SDK de Copilot para los servicios de back-end
Usa tus propias claves del modelo
Bring Your Own Key (BYOK)

Pasos siguientes

• Bring Your Own Key (BYOK)
• Persistencia de sesión en el SDK de Copilot
• Introducción al SDK de Copilot