Uso de la CLI de GitHub Copilot

Obtenga información sobre cómo usar GitHub Copilot desde la línea de comandos.

¿Quién puede utilizar esta característica?

CLI de GitHub Copilot está disponible con los planes GitHub Copilot Pro, GitHub Copilot Pro+, GitHub Copilot para empresas y GitHub Copilot para grandes empresas.

Si recibes Copilot de una organización, la directiva de CLI de Copilot debe estar habilitada en la configuración de la organización.

En este artículo

La interfaz de la línea de comandos (CLI) para GitHub Copilot te permite usar Copilot directamente desde el terminal. Para más información, consulta Acerca de la CLI de GitHub Copilot.

Nota:

CLI de GitHub Copilot se encuentra en versión preliminar pública y está sujeto a cambios.

Requisito previo

Instalar CLI de Copilot. Consulta Instalación de la CLI de GitHub Copilot.

Usar CLI de Copilot

  1. En el terminal, accede a una carpeta que contenga el código con el que deseas trabajar.

  2. Escribe copilot para iniciar CLI de Copilot.

    Copilot te pedirá que confirmes que confías en los archivos de esta carpeta.

    Importante

    Durante esta sesión de CLI de GitHub Copilot, Copilot puede intentar leer, modificar y ejecutar archivos dentro y debajo de esta carpeta. Solo debes continuar si confías en los archivos de esta ubicación. Para obtener más información acerca de los directorios de confianza, consulta Acerca de la CLI de GitHub Copilot.

  3. Elija una de las siguientes opciones:

    1. Sí, continúa:

    Copilot solo puede trabajar con los archivos de esta ubicación para esta sesión.

    2. Sí, y recuerda esta carpeta para futuras sesiones:

    Confías en los archivos de esta carpeta para esta y futuras sesiones. No se te volverá a preguntar cuando inicies CLI de Copilot desde esta carpeta. Elige esta opción solo si estás seguro de que siempre será seguro que Copilot trabaje con archivos en esta ubicación.

    3. No, salir (Esc):

    Finaliza tu sesión de CLI de Copilot.

  4. Si no has iniciado sesión actualmente en GitHub, se te pedirá que uses el comando de barra diagonal /login. Escribe este comando y sigue las instrucciones en pantalla para autenticarte.

  5. Escribe un mensaje en la CLI.

    Esto puede ser una pregunta de chat simple o una solicitud de Copilot para realizar una tarea específica, como corregir un error, agregar una característica a una aplicación existente o crear una nueva aplicación.

    Para ver algunos ejemplos de mensajes, consulta Acerca de la CLI de GitHub Copilot.

  6. Cuando Copilot desea usar una herramienta que pueda modificar o ejecutar archivos (Por ejemplo, touch, chmod, node, o sed), te pedirá que apruebes el uso de la herramienta.

    Elija una de las siguientes opciones:

    1. Sí:

    Permitir que Copilot use esta herramienta. La próxima vez que Copilot quiera usar esta herramienta, se te pedirá que la apruebes de nuevo.

    2. Sí, y aprobar HERRAMIENTA para el resto de la sesión en ejecución:

    Permite que Copilot use esta herramienta, con cualquier opción, sin preguntar de nuevo el resto de la sesión que se está ejecutando actualmente. Tendrás que volver a aprobar el comando en futuras sesiones.

    Elegir esta opción es útil para muchas herramientas, como chmod, por ejemplo, ya que evita tener que aprobar comandos similares repetidamente en la misma sesión. Sin embargo, debes tener en cuenta las implicaciones de seguridad de esta opción. Al elegir esta opción para el comando rm, por ejemplo, se permitiría que Copilot eliminara cualquier archivo de la carpeta actual o debajo de ella sin pedir tu aprobación.

    3. No, e indica a Copilot qué hacer de forma diferente (Esc):

    Copilot no ejecutará el comando. En su lugar, finaliza la operación actual y espera el siguiente mensaje. Puedes indicar a Copilot que continúe la tarea, pero con un enfoque diferente.

    Por ejemplo, si pides a Copilot que cree un script de Bash, pero no deseas usar el script que Copilot sugiere, puedes detener la operación actual y escribir un nuevo mensaje, como: Continue the previous task but include usage instructions in the script.

Sugerencias

Optimiza tu experiencia con CLI de Copilot con las siguientes sugerencias.

Detener una operación que se está ejecutando actualmente

Si escribes un mensaje y, a continuación, decides que deseas impedir que Copilot complete la tarea mientras sigue "Pensando", presiona Esc.

Incluir un archivo específico en la indicación

Para agregar un archivo específico a la indicación, usa @ seguido de la ruta de acceso relativa al archivo. Por ejemplo: Explain @config/ci/ci-required-checks.yml o Fix the bug in @src/app.js. Esto agrega el contenido del archivo a la indicación como contexto para Copilot.

Al empezar a escribir una ruta de acceso de archivo, las rutas de acceso coincidentes se muestran debajo del cuadro de indicación. Usa las teclas de dirección para seleccionar una ruta de acceso y presiona la tecla Tab para completar la ruta de acceso en la indicación.

Trabajar con archivos en una ubicación diferente

Para completar una tarea, es posible que Copilot necesite trabajar con archivos que están fuera del directorio de trabajo actual. Si un mensaje que has especificado en una sesión interactiva requiere que Copilot modifique un archivo fuera de la ubicación actual, se te pedirá que apruebes el acceso al directorio del archivo.

También puedes agregar manualmente un directorio de confianza en cualquier momento mediante el comando de barra diagonal:

/add-dir /path/to/directory

Si todos los archivos con los que deseas trabajar se encuentran en una ubicación diferente, puedes cambiar el directorio de trabajo actual sin iniciar una nueva sesión de CLI de Copilot mediante el comando de barra diagonal:

/cwd /path/to/directory

Reanudar una sesión interactiva

Puedes volver a una sesión interactiva anterior y continuar la conversación con Copilot mediante la opción de línea de comandos --resume y, a continuación, elegir la sesión que deseas reanudar en la lista que se muestra.

Usar instrucciones personalizadas

Puedes mejorar el rendimiento de Copilot agregando instrucciones personalizadas al repositorio en el que estás trabajando. Las instrucciones personalizadas son descripciones de lenguaje natural guardadas en archivos Markdown en el repositorio. Se incluyen automáticamente en los mensajes que escribas mientras trabajas en ese repositorio. Esto ayuda a que Copilot comprenda mejor el contexto del proyecto y cómo responder a tus indicaciones.

CLI de Copilot es compatible con:

  • Instrucciones para todo el repositorio en el archivo .github/copilot-instructions.md.
  • Archivos de instrucciones específicas de la ruta de acceso: .github/copilot-instructions/**/*.instructions.md.
  • Archivos de agente como AGENTS.md.

Para más información, consulta Incorporación de instrucciones personalizadas del repositorio para GitHub Copilot.

Agregar un servidor MCP

CLI de Copilot viene con el servidor MCP de GitHub ya configurado. Este servidor MCP te permite interactuar con recursos en GitHub.com, por ejemplo, lo que te permite combinar solicitudes de incorporación de cambios de la CLI.

Para ampliar la funcionalidad disponible en CLI de Copilot, puedes agregar más servidores MCP:

  1. Usa el siguiente comando de barra diagonal:

    /mcp add

  2. Rellena los detalles del servidor MCP que deseas agregar, con la tecla Tab para moverte entre los campos.

  3. Presiona Ctrl+S para guardar los detalles.

Los detalles de los servidores MCP configurados se almacenan en el archivo mcp-config.json, que se encuentra, de forma predeterminada, en el directorio ~/.config. Esta ubicación se puede cambiar estableciendo la variable de entorno XDG_CONFIG_HOME. Para obtener información sobre la estructura JSON de una definición de servidor, consulta Extensión del agente de codificación de GitHub Copilot con el protocolo de contexto de modelo (MCP).

Obtén más información

Para obtener una lista completa de las opciones de línea de comandos y los comandos de barra diagonal que puedes usar con CLI de Copilot, sigue uno de estos procedimientos:

  • Escribe ? en el cuadro de indicación de una sesión interactiva.
  • Escribe copilot help en el terminal.

Para obtener información adicional, usa uno de los siguientes comandos en el terminal:

  • Parámetros de configuración:

    copilot help config

    Puedes ajustar las opciones de configuración editando el archivo config.json, que se encuentra, de forma predeterminada, en el directorio ~/.config. Esta ubicación se puede cambiar estableciendo la variable de entorno XDG_CONFIG_HOME.

  • Variables de entorno que afectan a CLI de Copilot:

    copilot help environment

  • Niveles de registro disponibles:

    copilot help logging

  • Permisos para permitir o denegar el uso de la herramienta:

    copilot help permissions

Comentarios

Si tienes algún comentario sobre los datos de CLI de GitHub Copilot, háznoslo saber mediante el comando de barra diagonal /feedback en una sesión interactiva y eligiendo una de las opciones. Puedes completar una encuesta privada de comentarios, enviar un informe de errores o sugerir una nueva característica.