Pular para o conteúdo
Documentation

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.

SinalizadorObjetivo
--env NAMESubstituir o ambiente do Gateway ativo para um comando.
--profile IDUtilize outra conta armazenada para um comando sem alterar a conta ativa.
-v, --verboseRegistre os metadados da solicitação e da resposta com o cabeçalho de autorização ocultado.
--debugAdicione corpos de solicitação e resposta à saída de diagnóstico. Utilize com cautela ao lidar com dados confidenciais.
--jsonGerar JSON legível por máquina, quando compatível.
--no-colorDesativar 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.

ComandoObjetivo
champrep auth loginFaça login por meio da aprovação do navegador.
champrep auth login --no-browserImprimir uma URL de aprovação para um terminal remoto.
champrep auth tokenArmazenar uma APIchave com escopo no keychain do sistema operacional.
champrep auth whoamiExibir a identidade e o perfil ativos.
champrep auth statusExibir identidade, cota ativa e contexto de auditoria disponível.
champrep auth listListar perfis armazenados em todos os ambientes.
champrep auth switch PROFILESelecione outro perfil armazenado para a mesma conta.
champrep auth logoutRemova as credenciais locais atuais e o estado do perfil.
ComandoObjetivo
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 DESTTransferir um arquivo entre o computador local e Drive.
champrep drive mv OLD NEWMover ou renomear um itemDrive.
champrep drive rm REMOTE_PATHExcluir um arquivo ou pasta.
champrep drive mkdir REMOTE_PATHCriar uma pasta.
champrep drive quotaExibir o espaço de armazenamento utilizado e disponível.

Exemplos:

Terminal window
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
ComandoObjetivo
champrep mail lsListar mensagens em uma pasta da caixa de correio.
champrep mail read MESSAGE_IDImprimir uma mensagem.
champrep mail sendEnvie uma mensagem. --subject é obrigatório; para enviar sem ele, omita-o e passe --no-subject.
champrep mail accountsListar caixas de correio conectadas.
champrep mail threadsListar cadeias de e-mails.
champrep mail domainsListar 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.

ComandoObjetivo
champrep chat lsListar salas.
champrep chat read ROOM_IDLer mensagens recentes.
champrep chat send ROOM_IDEnviar uma mensagem para a sala.
champrep chat unreadMostrar a contagem de itens não lidos.
champrep chat createCriar uma sala.
ComandoObjetivo
champrep contacts lsListar contatos.
champrep contacts search QUERYPesquisar por e-mail ou nome.
champrep contacts read CONTACT_IDExibir um contato.
champrep contacts labelsListar rótulos.
champrep contacts add USER_IDAdicionar um usuário aos contatos.
champrep contacts update CONTACT_IDAtualizar os metadados de contato.
champrep contacts rm CONTACT_IDExcluir um contato.

courses também aceita o learn alias.

ComandoObjetivo
champrep courses lsListar os cursos disponíveis.
champrep courses enrolledListar as matrículas do usuário ativo.
champrep courses read COURSE_IDExibir um curso.
champrep courses sections COURSE_IDListar seções do curso.
ComandoObjetivo
champrep notes lsListar notas recentes.
champrep notes createCriar uma nota.
champrep notes read NOTE_IDImprimir uma nota.
champrep notes edit NOTE_IDAtualizar o título e/ou o corpo de uma nota.
champrep notes rm NOTE_IDMova 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.
ComandoObjetivo
eve ou champrep aiInicie o agente interativo de programação em pares com IA Eve no diretório atual.
champrep eveAlias para champrep ai / eve.
eve -p PROMPT ou champrep ai -p PROMPTExecute o agente sem interface gráfica para uma solicitação e exiba a resposta.
champrep ai models lsListar modelos da plataforma e modelos que você registrou com sua própria chave.
champrep ai models registerRegistre um modelo que utilize sua própria chaveAPI de provedor.
champrep ai models rm NAMERemova um modelo registrado e sua chave.
champrep ai pathsExiba 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 summarizeResumir um arquivo.
champrep ai conversationsListar conversas salvas.
champrep ai read CONVERSATION_IDLer uma conversa.
champrep ai rm CONVERSATION_IDExcluir uma conversa.
champrep ai usageMostrar 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).

ComandoObjetivo
champrep meet createCriar uma sala de reunião.
champrep meet lsListar reuniões.
champrep meet join MEETING_IDAbrir uma reunião no navegador padrão.

calendar também aceita o cal alias.

ComandoObjetivo
champrep calendar todayExibir os eventos de hoje.
champrep calendar weekExibir os eventos desta semana.
champrep calendar createCriar um evento.
champrep calendar rm EVENT_IDExcluir um evento.

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.

ComandoObjetivo
champrep search QUERYFaça uma pesquisa em todos os seus serviços.
champrep search servicesMostre quais serviços você pode pesquisar e se a pesquisa por IA está disponível.
SinalizadorObjetivo
-s, --serviceLimitar a um serviço (repetível). Mantém a consulta econômica.
--limitNúmero máximo de resultados por serviço (padrão: 5; máximo: 20).
--aiClassifique os resultados com IA e obtenha uma resposta breve. Utiliza seus próprios créditos de IA.
Terminal window
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.

ComandoObjetivo
champrep work boardsListar seus painéis.
champrep work board BOARD_IDExibir um quadro.
champrep work ticketsListar 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 TICKETExibir um ticket por ID ou chave (por exemplo ENG-7).
champrep work createCriar um ticket (--board, --title, --priority, --type).
Terminal window
champrep work tickets --mine
champrep work create --board 642f... --title "Fix login" --priority high --type bug
ComandoObjetivo
champrep invoice lsListar faturas. Filtrar por --status.
champrep invoice read INVOICE_IDExibir uma fatura.
champrep invoice issue INVOICE_IDEmitir um rascunho (de rascunho para emitido).
champrep invoice send INVOICE_IDEnviar uma fatura por e-mail (--to quando não houver nenhum destinatário cadastrado).
champrep invoice rm INVOICE_IDExcluir 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.

ComandoObjetivo
champrep forms lsListar seus formulários.
champrep forms read FORM_IDExibir um formulário.
champrep forms responses FORM_IDListar as respostas de um formulário.
champrep forms createCriar um formulário (--title, --description, --publish).
champrep forms publish FORM_IDPublicar um formulário rascunho.
champrep forms rm FORM_IDMover um formulário para a Lixeira.

ComandoObjetivo
champrep charts meExibir sua posição no organograma.
champrep charts treeImprimir o organograma como JSON.
champrep charts search QUERYPesquisar pessoas na organização.
champrep charts profile USER_IDImprimir o perfil de uma pessoa como JSON.

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

ComandoObjetivo
champrep business infoExibir sua organização e sua função nela.
champrep business membersListar membros da organização.
champrep business usageExibir estatísticas de uso da organização.

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.

ComandoObjetivo
champrep code projects ls / show / createListar, exibir e criar projetos.
champrep code repo clone-url PROJECTImprimir o endereço de clonagem (--ssh (para SSH).
champrep code cloneClone 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 PROJECTListar ramificações.
champrep code mr ls / show / create / merge / approveWork com solicitações de mesclagem.
champrep code issues ls / show / create / close / reopenWork com problemas.
champrep code pipelines ls / show / run / retry / cancelWork 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 / retryListar tarefas, imprimir ou acompanhar (--follow) um log, inicie tarefas manuais.
champrep code releases ls PROJECTListar versões.
champrep code runners ls / show / update / createListe os executores e quem está online, altere tags, pause e retome, crie um executor.
champrep code ssh-keys lsListe suas chaves SSH para o git via SSH.
Terminal window
champrep code clone --group acme --include-subgroups --dest ~/src --ssh
champrep code mr ls acme/web
champrep code pipelines run acme/web --ref main --yes
champrep code jobs log acme/web 4182 --follow

Receitas tarefa a tarefa para Code, Runner Farm e QA, incluindo o uso de CI, encontram-se em Tarefas comuns.

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.

ComandoObjetivo
champrep rf accounts ls / showListar as contas do farm nas quais você pode agir; exibir uma.
champrep rf connections lsListar conexões de código com hosts.
champrep rf pools ls / show / create / updateGerenciar pools de executores, incluindo --pause e --resume.
champrep rf usageCréditos e minutos para o período atual.
champrep rf jobs lsListar tarefas, incluindo as que estão em espera e as retidas.
Terminal window
champrep rf pools ls
champrep rf usage

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.

ComandoObjetivo
champrep qa repos ls / available / activate / deactivate / syncGerenciar as análises de controle de qualidade dos repositórios.
champrep qa scan REPOInicie uma varredura; --watch acompanha-a até o fim.
champrep qa scans ls / showListar e exibir varreduras.
champrep qa findings ls / show / dismiss / reopenFiltro (--severity, --cwe, --branch, --state) e classificar os resultados.
champrep qa gates status REPOExibe o resultado do controle de qualidade; encerra 1 quando ocorre uma falha.
champrep qa previews ls / show / create / extend / stopGerencie ambientes de pré-visualização.
champrep qa ide ls / start / open / stopGerencie espaços de trabalho do IDE na nuvem.
Terminal window
champrep qa scan code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --watch --yes
champrep qa findings ls --severity critical,high

Nessas 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.

ComandoObjetivo
champrep accountExibir sua identidade, plano e uso atual de limite de taxa, diário e de armazenamento.
Terminal window
champrep account
champrep account --json

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.

ComandoObjetivo
champrep keys lsListar suas chavesAPI.
champrep keys createCriar uma chave (--name, repetível --scope, --expires-in-days, --allowed-ip).
champrep keys get KEY_IDExibir os detalhes de uma chave.
champrep keys audit KEY_IDExibir o log de auditoria recente de uma chave.
champrep keys update KEY_IDAlterar nome, escopos, lista de IPs permitidos ou --active/--inactive.
champrep keys regenerate KEY_IDRotacionar o segredo (o segredo antigo deixa de funcionar).
champrep keys revoke KEY_IDExcluir uma chave.
Terminal window
champrep keys create --name "CI deploy" --scope drive:read --scope drive:write
champrep keys create --name "read-only" --scope '*' --expires-in-days 90

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

ComandoObjetivo
champrep billing subscriptionExibir sua assinatura atual (alias sub).
champrep billing cardsListar formas de pagamento salvas.
champrep billing receiptsListar recibos anteriores.

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

ComandoObjetivo
champrep webhooks lsListe seus webhooks.
champrep webhooks eventsListe os tipos de eventos aos quais você pode se inscrever.
champrep webhooks createCrie um webhook (--url, repetível --event). O segredo de assinatura é exibido uma única vez.
champrep webhooks rotate WEBHOOK_IDFaça a rotação do segredo de assinatura.
champrep webhooks rm WEBHOOK_IDExclua um webhook.

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

ComandoObjetivo
champrep config get KEYLeia um valor de configuração.
champrep config set KEY VALUEDefina um valor de configuração permitido. Um api_url ou web_url deve ser um https:// endereço ausente.
champrep config listImprima a configuração atual. Com --json as chaves são as do próprio arquivo (default_environment, api_url …).
champrep config pathImprima o caminho do arquivo de configuração.
champrep config env [NAME]Exiba ou defina o ambiente padrão.
champrep completion SHELLGere autocompletamento para Bash, Zsh, Fish ou PowerShell.
champrep versionVersã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ódigoSignificado
0Sucesso.
1Falha 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.
3A autenticação é necessária ou inválida.
4A credencial não possui o escopo necessário.
5Um limite atual do Gateway foi atingido.
6Falha de rede.
7Falha no Gateway ou no serviço.
8O 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.

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.