Empezar

Referencia de CLI

Instale, autentique, seleccione espacios de trabajo, administre paquetes y pistas y ejecute Epismo en CI.

El epismo CLI es el mejor lugar para comenzar con Epismo. También es útil para operaciones diarias y trabajos de CI. Las cargas útiles de CLI coinciden estrechamente con los cuerpos de solicitud de HTTP API, por lo que los ejemplos que funcionan localmente son buenos puntos de partida para las integraciones de productos.

Configuración y autenticación

Comience con Setup para instalar CLI y comprender la entrada/salida de JSON.

Luego use Authentication para iniciar sesión, cerrar sesión y comprender el almacenamiento de credenciales local.

Selección del espacio de trabajo

Cada comando CLI se ejecuta en un contexto de ejecución.

  1. Si se configura EPISMO_TOKEN, se utiliza el espacio de trabajo integrado del token.
  2. De lo contrario, se utiliza el valor predeterminado guardado de epismo workspace use $WORKSPACE_ID.
  3. Si no se selecciona ningún espacio de trabajo, los comandos utilizan el espacio personal.
epismo workspace list
epismo workspace current
epismo workspace use $WORKSPACE_ID
epismo workspace clear

Utilice workspace clear cuando desee que los comandos vuelvan a operar con datos personales.

Crear y leer paquetes

Los paquetes almacenan conocimientos y procesos reutilizables. Los paquetes workflow utilizan steps; Los paquetes context utilizan blocks.

epismo pack create --type context --title "Team onboarding" --personal \
  --blocks '[{"title":"Where things live","content":"Docs in Notion, code in GitHub, designs in Figma."}]'
epismo pack create --type workflow --title "Release review" --projects $PROJECT_ID \
  --steps '[{"title":"Summarize changes","content":"List merged PRs."},{"title":"Check migrations","content":"Confirm database impact."}]'

De forma predeterminada, pack get devuelve datos de esquema. Utilice --full para todo el contenido anidado o --block-id/--step-id para el contenido seleccionado.

epismo pack get $PACK_ID
epismo pack get $PACK_ID --full
epismo pack get @repo-map --block-id b001,b002
epismo pack get @handle/repo-map
epismo pack get https://epismo.ai/share/$SHARE_TOKEN
epismo pack get $PACK_ID --share-url

--share-url crea o devuelve un enlace compartido a pedido y agrega shareUrl a la respuesta. Crear o actualizar un paquete no genera uno automáticamente y solicitar un enlace no hace que un paquete privado sea público.

Paquetes de actualización

Las actualizaciones de paquetes utilizan la semántica PATCH. Los campos omitidos permanecen sin cambios. El contenido anidado se actualiza con matrices de operaciones.

epismo pack update @repo-map --blocks '[{"op":"add","title":"Local setup","content":"npm install"}]'
epismo pack update @repo-map --blocks '[{"op":"update","id":"b001","content":"Updated text"}]'
epismo pack update @repo-map --blocks '[{"op":"move","id":"b003","beforeId":"b001"}]'
epismo pack update @repo-map --blocks '[{"op":"remove","id":"b002"}]'

Los pasos del flujo de trabajo utilizan el mismo patrón hasta steps. Mover un paso cambia su orden sin cambiar dependsOn.

Crear y buscar pistas

Las pistas representan trabajo activo.

epismo track create --type task --title "Fix API docs" --personal \
  --task '{"status":"todo","dueDate":"2026-06-05"}'
 
epismo track create --type goal --title "Ship docs v1" --projects $PROJECT_ID \
  --goal '{"status":"on_track","progress":40}'

Los estados de las tareas son backlog, todo, in_progress y done. Los estados de los objetivos son not_started, on_track, at_risk, postponed y completed.

epismo track search --type task --personal --filter '{"status":["todo","in_progress"]}'
epismo track search --type goal --projects $PROJECT_ID --filter '{"progressMin":50}'

Utilice track apply cuando planifique varias tareas a la vez.

epismo track apply --personal --input '{
  "upserts": [
    {"id":"t001","title":"Task A","task":{"status":"todo"}},
    {"id":"t002","title":"Task B","task":{"status":"todo","dependsOn":["t001"]}}
  ]
}'

Los ID que no son UUID, como t001 y t002, crean nuevos registros y otros upserts pueden hacer referencia a ellos en la misma solicitud.

Utilice el comando epismo track review para generar revisiones de solo lectura y extraer aprendizaje del trabajo completado o pospuesto.

Alias

Los alias son referencias a paquetes legibles por humanos.

epismo alias upsert @deploy-review --reference $PACK_REFERENCE
epismo alias get @deploy-review
epismo alias get @handle/deploy-review
epismo alias list --type workflow
epismo alias delete @deploy-review

Los nombres de alias se almacenan sin el @ inicial. No pueden contener / ni caracteres de control. Los prefijos de propietario se utilizan sólo cuando se leen alias que pertenecen a otra persona.

Sugerencias

Las sugerencias son propuestas de mejora para paquetes basadas en texto. Cualquiera que sepa leer un paquete puede enviarle una sugerencia al propietario; Sólo el propietario lo resuelve.

epismo suggestion create @deploy-review --title "Add rollback step" --content "Document the rollback procedure."
epismo suggestion list --owner --status open
epismo suggestion resolve $SUGGESTION_ID --status applied

list devuelve las sugerencias que envió de forma predeterminada, su bandeja de entrada con --owner o las sugerencias de un solo paquete con --reference. Consulte Sugerencias para obtener el conjunto de comandos completo.

Espacio de trabajo y gestión de proyectos

Los espacios de trabajo son límites de la organización. Los proyectos son contenedores privados para compartir.

epismo workspace create --name "Team"
epismo workspace update $WORKSPACE_ID --name "New name"
epismo workspace checkout $WORKSPACE_ID
 
epismo workspace member list
epismo workspace member upsert $USER_ID --role admin
epismo workspace member upsert $USER_ID_1,$USER_ID_2 --role member
epismo workspace member delete $USER_ID
epismo workspace member delete $USER_ID_1,$USER_ID_2
epismo project list
epismo project create --name "Website" --description "Docs and marketing site"
epismo project update $PROJECT_ID --name "Website docs"
epismo project member add $USER_ID --project-id $PROJECT_ID
epismo project member add $USER_ID_1,$USER_ID_2 --project-id $PROJECT_ID

Agentes y créditos

Los agentes instalados se pueden asignar a tareas y pasos del flujo de trabajo.

epismo agent list
epismo agent add --agent-ids agent_a,agent_b
epismo agent remove --agent-ids '["agent_a","agent_b"]'

Utilice comandos de crédito para saldo y pago.

epismo credit balance
epismo credit checkout --quantity 500

Los costos de crédito CLI se enumeran por comando en Créditos. Para paquetes grandes, primero inspeccione el contorno y luego busque solo los bloques o escalones necesarios.

Hoja de referencia de comandos

Utilice Todos los comandos para obtener un índice de comandos compacto.

En esta sección