Acerca de las extensiones del GitHub CLI
Nota: Las extensiones fuera de GitHub y GitHub CLI no están certificadas por GitHub y se rigen por términos del servicio, directivas de privacidad y documentación de soporte diferentes. Para mitigar el riesgo al utilizar extensiones de terceros, audita el código fuente de la extensión antes de instalarla o actualizarla.
Las extensiones del GitHub CLI son comandos personalizados del GitHub CLI que cualquiera puede crear y utilizar. Para más información sobre cómo crear extensiones de GitHub CLI, consulta "Crear extensiones del CLI de GitHub".
Las extensiones se instalan localmente y se les da el alcance del usuario. Por lo tanto, si accedes al GitHub CLI desde una máquina diferente o si otro usuario accede al GitHub CLI desde la misma máquina, la extensión no estará disponible.
Búsqueda de extensiones
Puede encontrar extensiones si busca en los repositorios con el tema gh-extension
.
Instalación de extensiones
Para instalar una extensión, use el subcomando extensions install
. Reemplace el parámetro repo
con el repositorio de la extensión. Puede usar la dirección URL completa, como https://github.com/octocat/gh-whoami
, o bien solo el propietario y el repositorio, como octocat/gh-whoami
.
Si usa el propietario y el repositorio, gh
instalará la extensión con el nombre de host en el que gh
se autentica actualmente. El formato de URL completa es útil cuando se instalan extensiones desde un host diferente. Por ejemplo, los usuarios de GitHub Enterprise Server deben utilizar la URL completa del repositorio para instalar extensiones de GitHub.com o de cualquier otro host.
Para instalar una extensión en desarrollo desde el directorio actual, use .
como valor del parámetro repo
.
gh extension install REPO
Si ya tienes una extensión con el mismo nombre instalada, el comando fallará. Por ejemplo, si ha instalado octocat/gh-whoami
, debe desinstalarlo antes de instalar hubot/gh-whoami
.
Ejecución de una extensión
Cuando hayas instalado una extensión, ejecuta la extensión como ejecutarías un comando GitHub CLI nativo con gh EXTENSION-NAME
. EXTENSION-NAME
es el nombre del repositorio que contiene la extensión, menos el prefijo gh-
.
Por ejemplo, si has instalado la extensión desde el repositorio octocat/gh-whoami
, ejecutarías la extensión con el siguiente comando.
gh whoami
Normalmente, puedes encontrar información específica sobre cómo usar una extensión en el archivo LÉAME del repositorio que contiene la extensión.
Ver las extensiones instaladas
Para ver todas las extensiones instaladas, use el subcomando extensions list
. La salida también te dirá qué extensiones tienen actualizaciones disponibles.
gh extension list
Actualización de extensiones
Para actualizar una extensión, use el subcomando extensions upgrade
. Reemplace el parámetro extension
con el nombre de la extensión.
gh extension upgrade EXTENSION
Para actualizar todas las extensiones instaladas, use la marca --all
.
gh extension upgrade --all
Desinstalación de extensiones
Para desinstalar una extensión, use el subcomando extensions remove
. Reemplace el parámetro extension
con el nombre de la extensión.
gh extension remove EXTENSION