Configuración
La CLI lee cada ajuste de los flags, las variables de entorno, su archivo de configuración y los valores por defecto integrados, y guarda todo bajo ~/.polylane. Esta página lista el orden, las variables y cómo controlar la telemetría.
Precedencia
La CLI resuelve cada ajuste en este orden, el más alto gana:
- Flags de la CLI, por ejemplo
--workspace,--api-key,--outputy--timeout. - Variables de entorno: el conjunto
POLYLANE_*más las estándarNO_COLORyDO_NOT_TRACK. - Solo para la credencial, los tokens OAuth en
~/.polylane/credentials.json. - El archivo de configuración en
~/.polylane/config.json. - Valores por defecto integrados: dominio
api.polylane.com, tiempo de espera de 300 segundos, salidatexten una terminal yjsoncuando se encadena con una tubería.
Una POLYLANE_API_KEY exportada siempre gana a un ~/.polylane/credentials.json obsoleto, así que un runner de CI con la variable definida no recoge tokens OAuth sobrantes. Autenticación lista el mismo orden para las credenciales.
Archivo de configuración
~/.polylane/config.json acepta seis claves: domain, workspace_id, api_key, output, timeout y telemetry. Gestiónalo a través de la CLI: config show imprime la configuración resuelta, el método de autenticación en uso y la ruta del archivo, con las claves de API enmascaradas.
polylane config show
polylane config set --key output --value json
Para fijar el espacio de trabajo por defecto por slug en lugar de por id, ejecuta polylane workspace use <slug>. Las credenciales OAuth viven aparte en ~/.polylane/credentials.json y se renuevan por sí solas cuando el token de acceso se acerca a su caducidad.
Variables de entorno
| Variable | Descripción |
|---|---|
POLYLANE_API_KEY | Autentica sin guardar una clave en disco |
POLYLANE_WORKSPACE_ID | Fija el espacio de trabajo para la shell actual |
POLYLANE_API_DOMAIN | Apunta a otro nombre de host de la API; solo el nombre de host, sin protocolo |
POLYLANE_OUTPUT | Fuerza la salida text o json |
POLYLANE_TIMEOUT | Tiempo de espera de las peticiones en segundos |
POLYLANE_VERBOSE | Activa el registro detallado |
POLYLANE_TELEMETRY=0 | Desactiva la telemetría para este entorno |
DO_NOT_TRACK=1 | La exclusión universal de telemetría; prevalece sobre cualquier otro ajuste de telemetría, incluido el archivo de configuración |
NO_COLOR | Desactiva los colores ANSI |
Telemetría
La telemetría de uso anónima está activada por defecto. Registra el nombre del comando, los nombres de los flags, el número de argumentos posicionales, el código de salida y la categoría del error, duraciones, versiones de la CLI y de Node, detalles del sistema operativo, un identificador anónimo por instalación y el id del espacio de trabajo. Los valores de los flags, los argumentos, las rutas de archivos, la salida de los comandos y los mensajes de error completos quedan fuera, y polylane telemetry status muestra exactamente qué se envía y adónde.
Desactívala de forma permanente con polylane telemetry disable, que escribe en el archivo de configuración, o por entorno con POLYLANE_TELEMETRY=0 o DO_NOT_TRACK=1. La decisión sigue DO_NOT_TRACK, después POLYLANE_TELEMETRY, después el archivo de configuración y después el valor por defecto de activada; no hay un flag por invocación.
Archivos en disco
Todo lo que la CLI guarda vive bajo ~/.polylane:
| Archivo | Descripción |
|---|---|
config.json | Ajustes guardados: dominio, espacio de trabajo, clave de API, salida, tiempo de espera, telemetría |
credentials.json | Tokens OAuth |
telemetry.json | Id de instalación anónimo y contadores de ejecuciones |
update-state.json | Estado de la comprobación de actualizaciones |
Elimina el directorio para restablecer la CLI por completo; en la siguiente ejecución se genera un nuevo id de instalación.
Relacionado
- Autenticación: los métodos de inicio de sesión y cómo se eligen las credenciales.
- Scripting: el contrato de salida, los flags para scripts y los códigos de salida.