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
Seção intitulada “Sinalizadores globais”| Sinalizador | Objetivo |
|---|---|
--env NAME | Substituir o ambiente do Gateway ativo para um comando. |
--profile ID | Utilize outra conta armazenada para um comando sem alterar a conta ativa. |
-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
Seção intitulada “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. |
| 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 /projectschamprep drive cp ./report.pdf /reports/report.pdfchamprep drive cp /reports/report.pdf ./report.pdfchamprep drive quota --json| 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 | Envie uma mensagem. --subject é obrigatório; para enviar sem ele, omita-o e passe --no-subject. |
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.
| 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
Seção intitulada “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. |
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. |
| 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 | Mova uma nota para a Lixeira. Recupere-a em CHAMPREP Notes no prazo de 30 dias; depois disso, ela será apagada automaticamente. Uma nota na Lixeira pode ser lida, mas não editada. |
CHAMPREP AI (Eve)
Seção intitulada “CHAMPREP AI (Eve)”| Comando | Objetivo |
|---|---|
eve ou champrep ai | Inicie o agente interativo de programação em pares com IA Eve no diretório atual. |
champrep eve | Alias para champrep ai / eve. |
eve -p PROMPT ou champrep ai -p PROMPT | Execute o agente sem interface gráfica para uma solicitação e exiba a resposta. |
champrep ai models ls | Listar modelos da plataforma e modelos que você registrou com sua própria chave. |
champrep ai models register | Registre um modelo que utilize sua própria chaveAPI de provedor. |
champrep ai models rm NAME | Remova um modelo registrado e sua chave. |
champrep ai paths | Exiba todos os arquivos e pastas locais utilizados pelo agente. |
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.
Para os comandos com barra, permissões e opções do agente, consulte Agente de IA: Eve (champrep ai / eve).
| 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
Seção intitulada “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
Seção intitulada “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 mailchamprep search "what did we decide about pricing" --aiUma 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.
| 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 (um ID de status, ou com --board um nome de status), --search, --mine; --limit 1 a 200. |
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 --minechamprep work create --board 642f... --title "Fix login" --priority high --type bugInvoice
Seção intitulada “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.
| 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
Seção intitulada “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
Seção intitulada “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. |
CHAMPREP Code
Seção intitulada “CHAMPREP Code”Projetos, ramificações, solicitações de mesclagem, problemas, pipelines, registros de tarefas e versões.
PROJECT é o caminho completo do projeto (acme/web) ou seu ID. Referência completa:
CHAMPREP Comandos de código.
| Comando | Objetivo |
|---|---|
champrep code projects ls / show / create | Listar, exibir e criar projetos. |
champrep code repo clone-url PROJECT | Imprimir o endereço de clonagem (--ssh (para SSH). |
champrep code clone | Clone projetos, um grupo (--group, --include-subgroups) ou totalmente seu (--membership, --owned, --all) em uma árvore de namespace; --update mantém-no atualizado. |
champrep code branches ls PROJECT | Listar ramificações. |
champrep code mr ls / show / create / merge / approve | Work com solicitações de mesclagem. |
champrep code issues ls / show / create / close / reopen | Work com problemas. |
champrep code pipelines ls / show / run / retry / cancel | Work com pipelines. |
champrep code pipelines wait PROJECT [ID] | Aguarde um pipeline, o mais recente de um commit (--sha), ou a versão mais recente em --ref para encerrar; sai 0 em caso de sucesso, 1 caso contrário, 8 em --timeout. |
champrep code jobs ls / log / play / retry | Listar tarefas, imprimir ou acompanhar (--follow) um log, inicie tarefas manuais. |
champrep code releases ls PROJECT | Listar versões. |
champrep code runners ls / show / update / create | Liste os executores e quem está online, altere tags, pause e retome, crie um executor. |
champrep code ssh-keys ls | Liste suas chaves SSH para o git via SSH. |
champrep code clone --group acme --include-subgroups --dest ~/src --sshchamprep code mr ls acme/webchamprep code pipelines run acme/web --ref main --yeschamprep code jobs log acme/web 4182 --followReceitas tarefa a tarefa para Code, Runner Farm e QA, incluindo o uso de CI, encontram-se em Tarefas comuns.
Fazenda de Executores
Seção intitulada “Fazenda de Executores”runner-farm também aceita o rf alias. --workspace seleciona a conta da fazenda (personal, organization:<id>, team:<id>). Referência completa:
Comandos da Fazenda de Executores.
| Comando | Objetivo |
|---|---|
champrep rf accounts ls / show | Listar as contas do farm nas quais você pode agir; exibir uma. |
champrep rf connections ls | Listar conexões de código com hosts. |
champrep rf pools ls / show / create / update | Gerenciar pools de executores, incluindo --pause e --resume. |
champrep rf usage | Créditos e minutos para o período atual. |
champrep rf jobs ls | Listar tarefas, incluindo as que estão em espera e as retidas. |
champrep rf pools lschamprep rf usageCHAMPREP QA
Seção intitulada “CHAMPREP QA”Repositórios, varreduras, resultados, portas de qualidade, visualizações e espaços de trabalho IDE.
REPO é uma chave de repositório, como code:<project-uuid>. Referência completa:
CHAMPREP QA comandos.
| Comando | Objetivo |
|---|---|
champrep qa repos ls / available / activate / deactivate / sync | Gerenciar as análises de controle de qualidade dos repositórios. |
champrep qa scan REPO | Inicie uma varredura; --watch acompanha-a até o fim. |
champrep qa scans ls / show | Listar e exibir varreduras. |
champrep qa findings ls / show / dismiss / reopen | Filtro (--severity, --cwe, --branch, --state) e classificar os resultados. |
champrep qa gates status REPO | Exibe o resultado do controle de qualidade; encerra 1 quando ocorre uma falha. |
champrep qa previews ls / show / create / extend / stop | Gerencie ambientes de pré-visualização. |
champrep qa ide ls / start / open / stop | Gerencie espaços de trabalho do IDE na nuvem. |
champrep qa scan code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --watch --yeschamprep qa findings ls --severity critical,highNessas três famílias, os comandos que alteram algo ou utilizam minutos de CI, créditos ou limite de uso solicitam autorização previamente: code mr create, mr merge, mr approve,
issues close e reopen, a cada ação de pipeline e tarefa, rf pools create
e update, e a cada qa gravar (repos activate e deactivate, scan,
findings dismiss e reopen, previews create, extend e stop, ide start e stop). Passar --yes (-y) em scripts; sem um terminal e sem --yes, elas não alteram nada. A criação de um projeto ou issue no Code não solicita. --workspace em rf e qa seleciona a conta que será utilizada e cobrada.
Conta e uso
Seção intitulada “Conta e uso”| Comando | Objetivo |
|---|---|
champrep account | Exibir sua identidade, plano e uso atual de limite de taxa, diário e de armazenamento. |
champrep accountchamprep account --json
API chaves
Seção intitulada “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:writechamprep keys create --name "read-only" --scope '*' --expires-in-days 90
Faturamento
Seção intitulada “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
Seção intitulada “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
Seção intitulada “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. Um api_url ou web_url deve ser um https:// endereço ausente. |
champrep config list | Imprima a configuração atual. Com --json as chaves são as do próprio arquivo (default_environment, api_url …). |
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
Seção intitulada “Códigos de saída”| Código | Significado |
|---|---|
0 | Sucesso. |
1 | Falha geral ou de uso, ou uma recusa que não é resolvida ao fazer login novamente: sem acesso ao item, não incluído no seu plano, pagamento ou créditos necessários, sua função ou uma decisão que requer sua sessão na web. |
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. |
8 | O tempo de espera expirou: code pipelines wait --timeout. |
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
Seção intitulada “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.