CLI Referencia de comandos
Ejecutar champrep --help y champrep COMMAND --help para conocer los parámetros exactos que incluye la versión instalada. Esta página resume el árbol de comandos público actual.
Opciones globales
Sección titulada «Opciones globales»| Opción | Objetivo |
|---|---|
--env NAME | Anular el entorno de Gateway activo para un comando. |
--profile ID | Utilice otra cuenta almacenada para un comando sin cambiar la cuenta activa. |
-v, --verbose | Registrar los metadatos de las solicitudes y respuestas con el encabezado de autorización ocultado. |
--debug | Añada los cuerpos de las solicitudes y respuestas a la salida de diagnóstico. Úselo con precaución cuando se trate de datos confidenciales. |
--json | Generar JSON legible por máquina cuando sea compatible. |
--no-color | Desactivar el color ANSI. El tambiénCLI respeta NO_COLOR. |
Coloque indicadores persistentes antes o después de un subcomando, tal y como lo admite la versión instalada. Prefiera --json para la automatización.
Autenticación
Sección titulada «Autenticación»| Comando | Objetivo |
|---|---|
champrep auth login | Iniciar sesión mediante la autorización del navegador. |
champrep auth login --no-browser | Imprimir una URL de aprobación para un terminal remoto. |
champrep auth token | Almacenar una claveAPI con ámbito en el llavero del sistema operativo. |
champrep auth whoami | Mostrar la identidad y el perfil activos. |
champrep auth status | Mostrar la identidad, la cuota en tiempo real y el contexto de auditoría disponible. |
champrep auth list | Mostrar una lista de los perfiles almacenados en todos los entornos. |
champrep auth switch PROFILE | Seleccionar otro perfil almacenado para la misma cuenta. |
champrep auth logout | Eliminar las credenciales locales actuales y el estado del perfil. |
| Comando | Objetivo |
|---|---|
champrep drive ls [REMOTE_PATH] | Mostrar los archivos de una carpeta. |
champrep drive tree [REMOTE_PATH] | Mostrar un árbol de carpetas recursivo. |
champrep drive cp SOURCE DEST | Transferir un archivo entre el equipo local y Drive. |
champrep drive mv OLD NEW | Mover o renombrar un elementoDrive. |
champrep drive rm REMOTE_PATH | Eliminar un archivo o una carpeta. |
champrep drive mkdir REMOTE_PATH | Crear una carpeta. |
champrep drive quota | Mostrar el espacio de almacenamiento utilizado y disponible. |
Ejemplos:
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 | Mostrar los mensajes de una carpeta del buzón. |
champrep mail read MESSAGE_ID | Imprimir un mensaje. |
champrep mail send | Envíe un mensaje. --subject es obligatorio; para enviarlo sin él, omítalo y pase --no-subject. |
champrep mail accounts | Mostrar una lista de los buzones conectados. |
champrep mail threads | Mostrar los hilos de correo. |
champrep mail domains | Mostrar una lista de los dominios de correo visibles. |
Utilizar champrep mail send --help antes de crear un script de envío, para que los indicadores de destinatario, asunto, cuerpo y archivos adjuntos de la versión instalada se gestionen correctamente.
| Comando | Objetivo |
|---|---|
champrep chat ls | Mostrar las salas. |
champrep chat read ROOM_ID | Leer los mensajes recientes. |
champrep chat send ROOM_ID | Enviar un mensaje a la sala. |
champrep chat unread | Mostrar el recuento de mensajes no leídos. |
champrep chat create | Crear una sala. |
Contacts
Sección titulada «Contacts»| Comando | Objetivo |
|---|---|
champrep contacts ls | Mostrar la lista de contactos. |
champrep contacts search QUERY | Realizar una búsqueda por correo electrónico o nombre. |
champrep contacts read CONTACT_ID | Mostrar un contacto. |
champrep contacts labels | Mostrar una lista de etiquetas. |
champrep contacts add USER_ID | Añadir un usuario a los contactos. |
champrep contacts update CONTACT_ID | Actualizar los metadatos de un contacto. |
champrep contacts rm CONTACT_ID | Eliminar un contacto. |
courses También admite el learn alias.
| Comando | Objetivo |
|---|---|
champrep courses ls | Mostrar los cursos disponibles. |
champrep courses enrolled | Mostrar la lista de matrículas del usuario activo. |
champrep courses read COURSE_ID | Mostrar un curso. |
champrep courses sections COURSE_ID | Mostrar las secciones del curso. |
| Comando | Objetivo |
|---|---|
champrep notes ls | Mostrar las notas recientes. |
champrep notes create | Crear una nota. |
champrep notes read NOTE_ID | Imprimir una nota. |
champrep notes edit NOTE_ID | Actualizar el título y/o el cuerpo de una nota. |
champrep notes rm NOTE_ID | Mueva una nota a la Papelera. Restaure la nota en CHAMPREP Notes en un plazo de 30 días; transcurrido ese tiempo, se borrará automáticamente. Una nota en la Papelera se puede leer, pero no editar. |
CHAMPREP AI (Eve)
Sección titulada «CHAMPREP AI (Eve)»| Comando | Objetivo |
|---|---|
eve o champrep ai | Inicie el agente de programación en pareja con IA interactivo Eve en el directorio actual. |
champrep eve | Alias para champrep ai / eve. |
eve -p PROMPT o champrep ai -p PROMPT | Ejecute el agente en modo sin interfaz gráfica para una sola consulta y muestre la respuesta. |
champrep ai models ls | Muestre los modelos de la plataforma y los modelos que haya registrado con su propia clave. |
champrep ai models register | Registre un modelo que utilice su propia claveAPI de proveedor. |
champrep ai models rm NAME | Elimine un modelo registrado y su clave. |
champrep ai paths | Muestre todos los archivos y carpetas locales que utiliza el agente. |
champrep ai chat [PROMPT] | Plantee una pregunta puntual o inicie una sesión interactiva. |
champrep ai summarize | Resumir un archivo. |
champrep ai conversations | Mostrar las conversaciones guardadas. |
champrep ai read CONVERSATION_ID | Leer una conversación. |
champrep ai rm CONVERSATION_ID | Eliminar una conversación. |
champrep ai usage | Mostrar el uso actual de la IA. |
Revisar los resultados importantes de la IA antes de basarse en ellos.
Para conocer los comandos con barra, los permisos y las opciones del agente, consulte Agente de IA: Eve (champrep ai / eve).
| Comando | Objetivo |
|---|---|
champrep meet create | Crear una sala de reuniones. |
champrep meet ls | Mostrar las reuniones. |
champrep meet join MEETING_ID | Abrir una reunión en el navegador predeterminado. |
Calendar
Sección titulada «Calendar»calendar También admite el cal alias.
| Comando | Objetivo |
|---|---|
champrep calendar today | Mostrar los eventos de hoy. |
champrep calendar week | Mostrar los eventos de esta semana. |
champrep calendar create | Crear un evento. |
champrep calendar rm EVENT_ID | Eliminar un evento. |
Busque todo lo a lo que sus credenciales puedan acceder en una sola consulta. Los resultados se agrupan por servicio, y todo lo que se haya omitido se enumera indicando el motivo.
| Comando | Objetivo |
|---|---|
champrep search QUERY | Realice una búsqueda en todos sus servicios. |
champrep search services | Muestre qué servicios puede consultar y si la búsqueda mediante IA está disponible. |
| Opción | Objetivo |
|---|---|
-s, --service | Limitar a un servicio (repetible). Mantiene la consulta económica. |
--limit | Número máximo de resultados por servicio (por defecto 5, máximo 20). |
--ai | Clasifique los resultados con IA y obtenga una respuesta breve. Utiliza sus propios créditos de IA. |
champrep search "q3 roadmap"champrep search "invoice 1042" --service invoice --service mailchamprep search "what did we decide about pricing" --aiUna búsqueda cuesta una unidad de límite de tasa por cada servicio en el que se realice la búsqueda efectiva, por lo que restringir con --service es la forma más económica de mantener la respuesta ágil. --ai Consume sus créditos de IA mensuales; sin créditos, el comando sigue devolviendo resultados normales y le indica por qué no se ha ejecutado la clasificación mediante IA.
| Comando | Objetivo |
|---|---|
champrep work boards | Mostrar sus tableros. |
champrep work board BOARD_ID | Mostrar un tablero. |
champrep work tickets | Listar tickets. Filtrar por --board, --status (un ID de estado, o con --board un nombre de estado), --search, --mine; --limit 1 a 200. |
champrep work ticket TICKET | Mostrar un ticket por ID o clave (por ejemplo ENG-7). |
champrep work create | Crear un ticket (--board, --title, --priority, --type). |
champrep work tickets --minechamprep work create --board 642f... --title "Fix login" --priority high --type bugInvoice
Sección titulada «Invoice»| Comando | Objetivo |
|---|---|
champrep invoice ls | Mostrar una lista de facturas. Filtrar por --status. |
champrep invoice read INVOICE_ID | Mostrar una factura. |
champrep invoice issue INVOICE_ID | Emitir un borrador (de borrador a emitido). |
champrep invoice send INVOICE_ID | Enviar una factura por correo electrónico (--to cuando no haya ningún destinatario registrado). |
champrep invoice rm INVOICE_ID | Eliminar un borrador. |
La emisión y el envío consumen el cupo de envío de facturas de su plan, por lo que requieren el
invoice:send Ámbito de una claveAPI.
| Comando | Objetivo |
|---|---|
champrep forms ls | Mostrar sus formularios. |
champrep forms read FORM_ID | Mostrar un formulario. |
champrep forms responses FORM_ID | Mostrar las respuestas de un formulario. |
champrep forms create | Crear un formulario (--title, --description, --publish). |
champrep forms publish FORM_ID | Publicar un formulario borrador. |
champrep forms rm FORM_ID | Mover un formulario a la papelera. |
Organigrama
Sección titulada «Organigrama»| Comando | Objetivo |
|---|---|
champrep charts me | Mostrar su puesto en el organigrama. |
champrep charts tree | Imprima el organigrama en formato JSON. |
champrep charts search QUERY | Buscar personas en la organización. |
champrep charts profile USER_ID | Imprimir el perfil de una persona en formato JSON. |
Empresa
Sección titulada «Empresa»Gestión de la organización (empresa). Las lecturas utilizan el business:read ámbito.
| Comando | Objetivo |
|---|---|
champrep business info | Mostrar su organización y su función en ella. |
champrep business members | Mostrar los miembros de la organización. |
champrep business usage | Mostrar las estadísticas de uso de la organización. |
CHAMPREP Code
Sección titulada «CHAMPREP Code»Proyectos, ramas, solicitudes de fusión, incidencias, pipelines, registros de trabajos y versiones.
PROJECT es la ruta completa del proyecto (acme/web) o su ID. Referencia completa:
CHAMPREP Comandos de código.
| Comando | Objetivo |
|---|---|
champrep code projects ls / show / create | Listar, mostrar y crear proyectos. |
champrep code repo clone-url PROJECT | Imprimir la dirección de clonación (--ssh (para SSH). |
champrep code clone | Clone proyectos, un grupo (--group, --include-subgroups) o todo lo suyo (--membership, --owned, --all) en un árbol de espacios de nombres; --update lo mantiene actualizado. |
champrep code branches ls PROJECT | Mostrar una lista de ramas. |
champrep code mr ls / show / create / merge / approve | Work con solicitudes de fusión. |
champrep code issues ls / show / create / close / reopen | Work con incidencias. |
champrep code pipelines ls / show / run / retry / cancel | Work con pipelines. |
champrep code pipelines wait PROJECT [ID] | Espere a que se ejecute una canalización, la más reciente de una confirmación (--sha), o la versión más reciente en --ref para finalizar; sale 0 Si se ejecuta correctamente, 1 De lo contrario, 8 en --timeout. |
champrep code jobs ls / log / play / retry | Mostrar una lista de trabajos, imprimirlos o seguirlos (--follow) un registro, iniciar trabajos manuales. |
champrep code releases ls PROJECT | Mostrar una lista de versiones. |
champrep code runners ls / show / update / create | Muestre una lista de ejecutores y de quién está en línea, modifique etiquetas, pause y reanude, cree un ejecutor. |
champrep code ssh-keys ls | Enumere sus claves SSH para utilizar Git a través de 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 --followLas recetas paso a paso para Code, Runner Farm y QA, incluido el uso de CI, se encuentran en Tareas habituales.
Granja de ejecutores
Sección titulada «Granja de ejecutores»runner-farm También acepta el rf alias. --workspace selecciona la cuenta de la granja (personal, organization:<id>, team:<id>). Referencia completa:
Comandos de Runner Farm.
| Comando | Objetivo |
|---|---|
champrep rf accounts ls / show | Mostrar una lista de las cuentas de la granja en las que puede actuar; mostrar una. |
champrep rf connections ls | Mostrar una lista de las conexiones de los hosts de código. |
champrep rf pools ls / show / create / update | Gestionar grupos de ejecutores, incluidos --pause y --resume. |
champrep rf usage | Créditos y minutos para el periodo actual. |
champrep rf jobs ls | Mostrar una lista de trabajos, incluidos los que están en espera y los retenidos. |
champrep rf pools lschamprep rf usageCHAMPREP QA
Sección titulada «CHAMPREP QA»Repositorios, análisis, hallazgos, controles de calidad, vistas previas y espacios de trabajo IDE.
REPO es una clave de repositorio, como code:<project-uuid>. Referencia completa:
CHAMPREP QA comandos.
| Comando | Objetivo |
|---|---|
champrep qa repos ls / available / activate / deactivate / sync | Gestionar los análisis de control de calidad de los repositorios. |
champrep qa scan REPO | Iniciar un análisis; --watch Lo sigue hasta el final. |
champrep qa scans ls / show | Mostrar una lista de análisis y visualizarlos. |
champrep qa findings ls / show / dismiss / reopen | Filtro (--severity, --cwe, --branch, --state) y clasifica los hallazgos. |
champrep qa gates status REPO | Mostrar el resultado de la puerta de calidad; salir 1 cuando se produce un error. |
champrep qa previews ls / show / create / extend / stop | Gestione entornos de vista previa. |
champrep qa ide ls / start / open / stop | Gestione los espacios de trabajo del IDE en la nube. |
champrep qa scan code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --watch --yeschamprep qa findings ls --severity critical,highEn estas tres familias, los comandos que modifican algo o utilizan minutos de CI, créditos o asignaciones solicitan primero: code mr create, mr merge, mr approve,
issues close y reopen, cada acción de pipeline y de trabajo, rf pools create
y update, y cada qa escribir (repos activate y deactivate, scan,
findings dismiss y reopen, previews create, extend y stop, ide start y stop). Pase --yes (-y) en scripts; sin terminal y sin --yes, no modifican nada. Al crear un proyecto o una incidencia en Code, no se le solicita. --workspace en rf y qa selecciona la cuenta que se utiliza y a la que se le cobra.
Cuenta y uso
Sección titulada «Cuenta y uso»| Comando | Objetivo |
|---|---|
champrep account | Mostrar su identidad, plan y uso actual de los límites de velocidad, el consumo diario y el almacenamiento. |
champrep accountchamprep account --json
API claves
Sección titulada «API claves»Gestionar el cpk_... Claves utilizadas para el acceso sin interfaz gráfica y de CI. Estos comandos requieren una sesión interactiva del navegador (ejecutar champrep auth login «first», no
auth token). Al crear o rotar una clave, se muestra el secreto una sola vez.
| Comando | Objetivo |
|---|---|
champrep keys ls | Mostrar sus clavesAPI. |
champrep keys create | Crear una clave (--name, repetible --scope, --expires-in-days, --allowed-ip). |
champrep keys get KEY_ID | Mostrar los detalles de una clave. |
champrep keys audit KEY_ID | Mostrar el registro de auditoría reciente de una clave. |
champrep keys update KEY_ID | Modificar el nombre, los ámbitos, la lista de direcciones IP permitidas o --active/--inactive. |
champrep keys regenerate KEY_ID | Rotar el secreto (el secreto antiguo dejará de funcionar). |
champrep keys revoke KEY_ID | Eliminar una clave. |
champrep keys create --name "CI deploy" --scope drive:read --scope drive:writechamprep keys create --name "read-only" --scope '*' --expires-in-days 90
Facturación
Sección titulada «Facturación»Vista de solo lectura de su suscripción. Cambie de plan en el panel de facturación.
| Comando | Objetivo |
|---|---|
champrep billing subscription | Mostrar su suscripción actual (alias sub). |
champrep billing cards | Mostrar los métodos de pago guardados. |
champrep billing receipts | Mostrar los recibos anteriores. |
Webhooks
Sección titulada «Webhooks»Gestionar suscripciones a webhooks salientes. Utiliza el webhooks:manage ámbito.
| Comando | Objetivo |
|---|---|
champrep webhooks ls | Enumere sus webhooks. |
champrep webhooks events | Enumere los tipos de eventos a los que puede suscribirse. |
champrep webhooks create | Cree un webhook (--url, repetible --event). El secreto de firma se muestra una sola vez. |
champrep webhooks rotate WEBHOOK_ID | Rote el secreto de firma. |
champrep webhooks rm WEBHOOK_ID | Elimine un webhook. |
Configuración local y herramientas
Sección titulada «Configuración local y herramientas»Estos comandos no requieren una solicitud de servicio a menos que su texto de ayuda indique lo contrario.
| Comando | Objetivo |
|---|---|
champrep config get KEY | Lea un valor de configuración. |
champrep config set KEY VALUE | Establezca un valor de configuración permitido. Un api_url o web_url debe ser un https:// ». |
champrep config list | Imprima la configuración actual. Con --json Las claves son las propias del archivo (default_environment, api_url …). |
champrep config path | Muestre la ruta del archivo de configuración. |
champrep config env [NAME] | Mostrar o establecer el entorno predeterminado. |
champrep completion SHELL | Genere autocompletado para Bash, Zsh, Fish o PowerShell. |
champrep version | Versión de impresión, confirmación, fecha de compilación e información de tiempo de ejecución. |
Los tokens no se almacenan en el archivo de configuración. No intente escribir un token de autenticación con config set.
Códigos de salida
Sección titulada «Códigos de salida»| Código | Significado |
|---|---|
0 | Éxito. |
1 | Error general o de uso, o un rechazo que no se soluciona al volver a iniciar sesión: no tiene acceso al elemento, no está incluido en su plan, se requiere pago o créditos, su rol, o una decisión que requiere su sesión web. |
3 | Se requiere autenticación o esta no es válida. |
4 | La credencial carece del ámbito requerido. |
5 | Se ha alcanzado un límite de la pasarela en tiempo real. |
6 | Fallo de red. |
7 | Fallo de la pasarela o del servicio. |
8 | Se ha agotado el tiempo de espera: code pipelines wait --timeout. |
Los scripts deben comprobar el código de salida y analizar --json salida cuando esté disponible. No considere las frases de error legibles para el usuario como una interfaz estable.
Límites de tasa
Sección titulada «Límites de tasa»Cada respuesta de la pasarela incluye sus límites actuales. La vuelve a intentar de forma transparenteCLI un límite breve por minuto, respetando Retry-After. Lo hace no no espera hasta alcanzar un límite diario ni ninguna espera superior a unos segundos; en su lugar, sale con un código 5 y notifica el tiempo de espera exacto, de modo que los scripts fallen rápidamente. Compruebe sus contadores en tiempo real en cualquier momento con champrep account.