CLI

Autenticação

Faça login na CLI com o seu navegador, um código de dispositivo ou uma chave de API, e configure credenciais para scripts e CI.

A CLI faz login pelo seu navegador, por um código de dispositivo ou por uma chave de API, e em scripts e CI ela lê a credencial de uma flag ou de uma variável de ambiente. Execute polylane auth login para escolher um método de forma interativa, ou passe uma flag para pular o seletor.

Métodos de login

MétodoComandoDescrição
Navegadorpolylane auth loginPara uso interativo. A CLI abre o seu navegador, recebe os tokens em um callback em localhost e os renova conforme expiram.
Código de dispositivopolylane auth login --no-browserPara SSH e máquinas sem interface gráfica. A CLI imprime uma URL e um código; abra a URL em qualquer dispositivo, informe o código, e a CLI consulta até você aprovar.
Chave de APIpolylane auth login --api-key sk_xxxxxPara scripts, CI e agentes. A CLI valida a chave e a armazena com um workspace padrão.

Após o login, a CLI mostra quem você é e, se você pertence a mais de um workspace, pede que escolha um padrão, salvo como workspace_id em ~/.polylane/config.json. Force uma renovação de token com polylane auth refresh.

Chaves de API

Crie uma chave em Settings > API Keys com Create an API key: dê um nome, escolha os escopos e copie-a, porque ela é mostrada uma vez. As chaves começam com sk_. Em CI, defina POLYLANE_API_KEY no ambiente em vez de executar a etapa de login, ou passe a flag global --api-key <key> em uma única chamada.

Precedência de credenciais

Quando várias credenciais estão presentes, a CLI as resolve nesta ordem:

  1. A flag --api-key no comando atual
  2. A variável de ambiente POLYLANE_API_KEY
  3. Credenciais OAuth em ~/.polylane/credentials.json
  4. api_key em ~/.polylane/config.json

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. polylane auth status mostra qual fonte está em uso.

Verificar e alternar

Terminal
polylane auth status
polylane auth whoami
polylane auth logout

auth status mostra o método em uso, um token mascarado, o usuário e o workspace; auth whoami mostra o usuário atual. auth logout revoga os tokens OAuth e limpa as credenciais armazenadas após uma confirmação, que --yes pula; para trocar de conta, faça logout e login com a outra credencial.

Variáveis de ambiente

VariávelDescrição
POLYLANE_API_KEYChave de API para autenticação não interativa
POLYLANE_WORKSPACE_IDWorkspace padrão (id ws_)
POLYLANE_API_DOMAINSubstituição do hostname da API

Use-as em jobs de CI e contêineres onde você não quer escrever em ~/.polylane/. Configuração lista o conjunto completo.

Relacionado

  • Configuração: a ordem de precedência completa, toda variável de ambiente e os arquivos em disco.
  • Scripting: saída JSON, códigos de saída e as flags para CI e agentes.
  • Chaves de API e OAuth: escopos, gerenciamento de chaves e clientes OAuth.