CLI Referência de comandos

Executar champrep --help e champrep COMMAND --help para as opções exatas fornecidas pela versão instalada. Esta página resume a árvore de comandos pública atual.

Sinalizadores globais

Sinalizador	Objetivo
--env NAME	Substituir o ambiente do Gateway ativo para um comando.
-v, --verbose	Registre os metadados da solicitação e da resposta com o cabeçalho de autorização ocultado.
--debug	Adicione corpos de solicitação e resposta à saída de diagnóstico. Utilize com cautela ao lidar com dados confidenciais.
--json	Gerar JSON legível por máquina, quando compatível.
--no-color	Desativar cores ANSI. O tambémCLI respeita NO_COLOR.

Coloque sinalizadores persistentes antes ou depois de um subcomando, conforme aceito pela versão instalada. Prefira --json para automação.

Autenticação

Comando	Objetivo
champrep auth login	Faça login por meio da aprovação do navegador.
champrep auth login --no-browser	Imprimir uma URL de aprovação para um terminal remoto.
champrep auth token	Armazenar uma APIchave com escopo no keychain do sistema operacional.
champrep auth whoami	Exibir a identidade e o perfil ativos.
champrep auth status	Exibir identidade, cota ativa e contexto de auditoria disponível.
champrep auth list	Listar perfis armazenados em todos os ambientes.
champrep auth switch PROFILE	Selecione outro perfil armazenado para a mesma conta.
champrep auth logout	Remova as credenciais locais atuais e o estado do perfil.

Drive

Comando	Objetivo
champrep drive ls [REMOTE_PATH]	Listar arquivos em uma pasta.
champrep drive tree [REMOTE_PATH]	Exibir uma árvore de pastas recursiva.
champrep drive cp SOURCE DEST	Transferir um arquivo entre o computador local e Drive.
champrep drive mv OLD NEW	Mover ou renomear um itemDrive.
champrep drive rm REMOTE_PATH	Excluir um arquivo ou pasta.
champrep drive mkdir REMOTE_PATH	Criar uma pasta.
champrep drive quota	Exibir o espaço de armazenamento utilizado e disponível.

Exemplos:

champrep drive ls /
champrep drive tree /projects
champrep drive cp ./report.pdf /reports/report.pdf
champrep drive cp /reports/report.pdf ./report.pdf
champrep drive quota --json

Mail

Comando	Objetivo
champrep mail ls	Listar mensagens em uma pasta da caixa de correio.
champrep mail read MESSAGE_ID	Imprimir uma mensagem.
champrep mail send	Enviar uma mensagem utilizando sinalizadores ou prompts.
champrep mail accounts	Listar caixas de correio conectadas.
champrep mail threads	Listar cadeias de e-mails.
champrep mail domains	Listar domínios de e-mail visíveis.

Utilize champrep mail send --help antes de criar um script de envio, para que os flags de destinatário, assunto, corpo e anexo da versão instalada sejam tratados corretamente.

Chat

Comando	Objetivo
champrep chat ls	Listar salas.
champrep chat read ROOM_ID	Ler mensagens recentes.
champrep chat send ROOM_ID	Enviar uma mensagem para a sala.
champrep chat unread	Mostrar a contagem de itens não lidos.
champrep chat create	Criar uma sala.

Contacts

Comando	Objetivo
champrep contacts ls	Listar contatos.
champrep contacts search QUERY	Pesquisar por e-mail ou nome.
champrep contacts read CONTACT_ID	Exibir um contato.
champrep contacts labels	Listar rótulos.
champrep contacts add USER_ID	Adicionar um usuário aos contatos.
champrep contacts update CONTACT_ID	Atualizar os metadados de contato.
champrep contacts rm CONTACT_ID	Excluir um contato.

Learn

courses também aceita o learn alias.

Comando	Objetivo
champrep courses ls	Listar os cursos disponíveis.
champrep courses enrolled	Listar as matrículas do usuário ativo.
champrep courses read COURSE_ID	Exibir um curso.
champrep courses sections COURSE_ID	Listar seções do curso.

Notes

Comando	Objetivo
champrep notes ls	Listar notas recentes.
champrep notes create	Criar uma nota.
champrep notes read NOTE_ID	Imprimir uma nota.
champrep notes edit NOTE_ID	Atualizar o título e/ou o corpo de uma nota.
champrep notes rm NOTE_ID	Excluir uma nota.

CHAMPREP AI

Comando	Objetivo
champrep ai chat [PROMPT]	Fazer uma pergunta pontual ou iniciar uma sessão interativa.
champrep ai summarize	Resumir um arquivo.
champrep ai conversations	Listar conversas salvas.
champrep ai read CONVERSATION_ID	Ler uma conversa.
champrep ai rm CONVERSATION_ID	Excluir uma conversa.
champrep ai usage	Mostrar o uso atual da IA.

Analise os resultados importantes da IA antes de confiar neles.

Meet

Comando	Objetivo
champrep meet create	Criar uma sala de reunião.
champrep meet ls	Listar reuniões.
champrep meet join MEETING_ID	Abrir uma reunião no navegador padrão.

Calendar

calendar também aceita o cal alias.

Comando	Objetivo
champrep calendar today	Exibir os eventos de hoje.
champrep calendar week	Exibir os eventos desta semana.
champrep calendar create	Criar um evento.
champrep calendar rm EVENT_ID	Excluir um evento.

Pesquisar

Pesquise tudo o que suas credenciais permitirem em uma única consulta. Os resultados são agrupados por serviço, e tudo o que for ignorado é listado com o motivo.

Comando	Objetivo
champrep search QUERY	Faça uma pesquisa em todos os seus serviços.
champrep search services	Mostre quais serviços você pode pesquisar e se a pesquisa por IA está disponível.

Sinalizador	Objetivo
-s, --service	Limitar a um serviço (repetível). Mantém a consulta econômica.
--limit	Número máximo de resultados por serviço (padrão: 5; máximo: 20).
--ai	Classifique os resultados com IA e obtenha uma resposta breve. Utiliza seus próprios créditos de IA.

champrep search "q3 roadmap"
champrep search "invoice 1042" --service invoice --service mail
champrep search "what did we decide about pricing" --ai

Uma pesquisa custa uma unidade de limite de taxa por serviço efetivamente pesquisado; portanto, restringir com --service é a maneira mais econômica de manter a resposta ágil. --ai Consome seus créditos mensais de IA; sem créditos, o comando ainda retorna resultados normais e informa por que a classificação por IA não foi executada.

Work

Comando	Objetivo
champrep work boards	Listar seus painéis.
champrep work board BOARD_ID	Exibir um quadro.
champrep work tickets	Listar tickets. Filtrar por --board, --status, --search, --mine.
champrep work ticket TICKET	Exibir um ticket por ID ou chave (por exemplo ENG-7).
champrep work create	Criar um ticket (--board, --title, --priority, --type).

champrep work tickets --mine
champrep work create --board 642f... --title "Fix login" --priority high --type bug

Invoice

Comando	Objetivo
champrep invoice ls	Listar faturas. Filtrar por --status.
champrep invoice read INVOICE_ID	Exibir uma fatura.
champrep invoice issue INVOICE_ID	Emitir um rascunho (de rascunho para emitido).
champrep invoice send INVOICE_ID	Enviar uma fatura por e-mail (--to quando não houver nenhum destinatário cadastrado).
champrep invoice rm INVOICE_ID	Excluir um rascunho.

A emissão e o envio consomem a cota de envio de faturas do seu plano; portanto, exigem a invoice:send escopo em uma chaveAPI.

Forms

Comando	Objetivo
champrep forms ls	Listar seus formulários.
champrep forms read FORM_ID	Exibir um formulário.
champrep forms responses FORM_ID	Listar as respostas de um formulário.
champrep forms create	Criar um formulário (--title, --description, --publish).
champrep forms publish FORM_ID	Publicar um formulário rascunho.
champrep forms rm FORM_ID	Mover um formulário para a Lixeira.

Organograma

Comando	Objetivo
champrep charts me	Exibir sua posição no organograma.
champrep charts tree	Imprimir o organograma como JSON.
champrep charts search QUERY	Pesquisar pessoas na organização.
champrep charts profile USER_ID	Imprimir o perfil de uma pessoa como JSON.

Negócios

Gerenciamento da organização (empresa). As consultas utilizam o business:read escopo.

Comando	Objetivo
champrep business info	Exibir sua organização e sua função nela.
champrep business members	Listar membros da organização.
champrep business usage	Exibir estatísticas de uso da organização.

Conta e uso

Comando	Objetivo
champrep account	Exibir sua identidade, plano e uso atual de limite de taxa, diário e de armazenamento.

champrep account
champrep account --json

API chaves

Gerenciar o cpk_... Chaves utilizadas para acesso headless e CI. Esses comandos exigem uma sessão interativa no navegador (execute champrep auth login primeiro, não auth token). Ao criar ou alternar uma chave, o segredo é exibido uma vez.

Comando	Objetivo
champrep keys ls	Listar suas chavesAPI.
champrep keys create	Criar uma chave (--name, repetível --scope, --expires-in-days, --allowed-ip).
champrep keys get KEY_ID	Exibir os detalhes de uma chave.
champrep keys audit KEY_ID	Exibir o log de auditoria recente de uma chave.
champrep keys update KEY_ID	Alterar nome, escopos, lista de IPs permitidos ou --active/--inactive.
champrep keys regenerate KEY_ID	Rotacionar o segredo (o segredo antigo deixa de funcionar).
champrep keys revoke KEY_ID	Excluir uma chave.

champrep keys create --name "CI deploy" --scope drive:read --scope drive:write
champrep keys create --name "read-only" --scope '*' --expires-in-days 90

Faturamento

Visualização somente leitura da sua assinatura. Altere planos no painel de faturamento.

Comando	Objetivo
champrep billing subscription	Exibir sua assinatura atual (alias sub).
champrep billing cards	Listar formas de pagamento salvas.
champrep billing receipts	Listar recibos anteriores.

Webhooks

Gerenciar assinaturas de webhooks de saída. Utiliza o webhooks:manage escopo.

Comando	Objetivo
champrep webhooks ls	Liste seus webhooks.
champrep webhooks events	Liste os tipos de eventos aos quais você pode se inscrever.
champrep webhooks create	Crie um webhook (--url, repetível --event). O segredo de assinatura é exibido uma única vez.
champrep webhooks rotate WEBHOOK_ID	Faça a rotação do segredo de assinatura.
champrep webhooks rm WEBHOOK_ID	Exclua um webhook.

Configuração local e ferramentas

Esses comandos não requerem uma solicitação de serviço, a menos que o texto de ajuda indique o contrário.

Comando	Objetivo
champrep config get KEY	Leia um valor de configuração.
champrep config set KEY VALUE	Defina um valor de configuração permitido.
champrep config list	Imprima a configuração atual.
champrep config path	Imprima o caminho do arquivo de configuração.
champrep config env [NAME]	Exiba ou defina o ambiente padrão.
champrep completion SHELL	Gere autocompletamento para Bash, Zsh, Fish ou PowerShell.
champrep version	Versão de impressão, commit, data de compilação e informações de tempo de execução.

Os tokens não são armazenados no arquivo de configuração. Não tente gravar um token de autenticação com config set.

Códigos de saída

Código	Significado
0	Sucesso.
1	Falha geral ou de uso.
3	A autenticação é necessária ou inválida.
4	A credencial não possui o escopo necessário.
5	Um limite atual do Gateway foi atingido.
6	Falha de rede.
7	Falha no Gateway ou no serviço.

Os scripts devem verificar o código de saída e analisar --json saída quando estiver disponível. Não considere frases de erro legíveis por humanos como uma interface estável.

Limites de taxa

Cada resposta do Gateway contém seus limites atuais. A CLI retenta de forma transparenteCLI um limite curto por minuto, respeitando Retry-After. Ela faz não não fica em espera durante um limite diário ou qualquer espera superior a alguns segundos — em vez disso, ela encerra com código 5 e relata o tempo exato de espera, para que os scripts falhem rapidamente. Verifique seus contadores em tempo real a qualquer momento com champrep account.