Saltar al contenido principal

Requisitos

  • Node.js 20 o superior
  • Un gestor de paquetes compatible con npm

Instalación

El paquete instala un único binario chainpatrol. Verifícalo:
El paquete de npm es @chainpatrol/cli. El paquete chainpatrol sin scope en npm es un marcador de posición (placeholder) para el SDK de JavaScript y no contiene la CLI.
Para ejecutarla una vez sin instalarla de forma global:

Actualización

Mientras se ejecuta tu comando, la CLI consulta npm en segundo plano para ver si hay una versión más nueva y muestra un aviso de una línea cuando existe. La verificación se omite en los modos --json y --quiet para que nunca pueda corromper la salida legible por máquinas, y nunca retrasa tu comando más de medio segundo.

Configuración

La configuración se guarda en config.json, dentro del directorio de configuración de la CLI:
  • $XDG_CONFIG_HOME/chainpatrol/ (por defecto, ~/.config/chainpatrol/)
  • ~/.chainpatrol/ se sigue usando si ya existe y el directorio XDG no
  • $CHAINPATROL_CONFIG_DIR tiene prioridad sobre ambos
~/.config/chainpatrol/config.json

Definir una organización predeterminada

La mayoría de los comandos con alcance de organización aceptan --org <slug>. Al pasarlo, el slug se guarda como tu valor predeterminado, así que los comandos posteriores pueden omitirlo:
La organización se resuelve en este orden:
1

Flag --org

Un --org <slug> explícito siempre gana, y se escribe de vuelta en config.json.
2

Valor predeterminado guardado

defaultOrg de config.json.
3

Variable de entorno

CHAINPATROL_ORG, útil en CI, donde no quieres escribir un archivo de configuración.
Si ninguno de ellos se resuelve, el comando falla con Organization required. Use --org <slug> to specify one. y el código de salida 3.
Los comandos autenticados con una clave de API con alcance de organización resuelven la organización del lado del servidor a partir de la clave, así que --org es opcional para ellos.

Variables de entorno

Autocompletado del shell

chainpatrol setup instala el autocompletado por ti. Para escribir el script tú mismo:
Reinicia tu shell para que lo tome.

Desinstalación

Para eliminar también las credenciales y la configuración guardadas, borra el directorio de configuración: