Configuração
A CLI lê cada configuração de flags, variáveis de ambiente, seu arquivo de configuração e padrões embutidos, e armazena tudo em ~/.polylane. Esta página lista a ordem, as variáveis e como controlar a telemetria.
Precedência
A CLI resolve cada configuração nesta ordem, a mais alta vence:
- Flags da CLI, por exemplo
--workspace,--api-key,--outpute--timeout. - Variáveis de ambiente: o conjunto
POLYLANE_*mais as padrãoNO_COLOReDO_NOT_TRACK. - Apenas para a credencial, tokens OAuth em
~/.polylane/credentials.json. - O arquivo de configuração em
~/.polylane/config.json. - Padrões embutidos: domínio
api.polylane.com, timeout de 300 segundos, saídatextem um terminal ejsonquando encadeada.
Um POLYLANE_API_KEY exportado sempre vence um ~/.polylane/credentials.json obsoleto, então um runner de CI com a variável definida não pega tokens OAuth deixados para trás. Autenticação lista a mesma ordem para credenciais.
Arquivo de configuração
~/.polylane/config.json aceita seis chaves: domain, workspace_id, api_key, output, timeout e telemetry. Gerencie-o pela CLI: config show imprime a configuração resolvida, o método de autenticação em uso e o caminho do arquivo, com as chaves de API mascaradas.
polylane config show
polylane config set --key output --value json
Para definir o workspace padrão pelo slug em vez do id, execute polylane workspace use <slug>. As credenciais OAuth ficam separadas em ~/.polylane/credentials.json e se renovam sozinhas quando o access token se aproxima da expiração.
Variáveis de ambiente
| Variável | Descrição |
|---|---|
POLYLANE_API_KEY | Autentique sem armazenar uma chave em disco |
POLYLANE_WORKSPACE_ID | Defina o workspace para o shell atual |
POLYLANE_API_DOMAIN | Aponte para um hostname de API diferente; apenas o hostname, sem protocolo |
POLYLANE_OUTPUT | Force a saída text ou json |
POLYLANE_TIMEOUT | Timeout das requisições em segundos |
POLYLANE_VERBOSE | Habilite logging detalhado |
POLYLANE_TELEMETRY=0 | Desabilite a telemetria para este ambiente |
DO_NOT_TRACK=1 | O opt-out universal de telemetria; sobrepõe toda outra configuração de telemetria, incluindo o arquivo de configuração |
NO_COLOR | Desabilite as cores ANSI |
Telemetria
A telemetria anônima de uso fica ligada por padrão. Ela registra o nome do comando, os nomes das flags, a contagem de argumentos posicionais, o código de saída e a categoria do erro, durações, versões da CLI e do Node, detalhes do sistema operacional, um identificador anônimo por instalação e o id do workspace. Valores de flags, argumentos, caminhos de arquivos, saída de comandos e mensagens de erro completas ficam fora dela, e polylane telemetry status mostra exatamente o que é enviado e para onde.
Desligue-a de vez com polylane telemetry disable, que escreve no arquivo de configuração, ou por ambiente com POLYLANE_TELEMETRY=0 ou DO_NOT_TRACK=1. A decisão segue DO_NOT_TRACK, depois POLYLANE_TELEMETRY, depois o arquivo de configuração, depois o padrão de ligada; não há flag por invocação.
Arquivos em disco
Tudo o que a CLI armazena fica em ~/.polylane:
| Arquivo | Descrição |
|---|---|
config.json | Configurações salvas: domínio, workspace, chave de API, saída, timeout, telemetria |
credentials.json | Tokens OAuth |
telemetry.json | Id anônimo de instalação e contadores de execução |
update-state.json | Estado da verificação de atualizações |
Exclua o diretório para redefinir a CLI por completo; um novo id de instalação é gerado na próxima execução.
Relacionado
- Autenticação: os métodos de login e como as credenciais são escolhidas.
- Scripting: o contrato de saída, as flags para scripts e os códigos de saída.