Skip to Content
Atlassian Jiraajatv1.0.xUtilidades

Utilidades

Esta página documenta los comandos de diagnóstico y descubrimiento que enmarcan el flujo operativo seguro de ajat: validar la estación de trabajo, inspeccionar la superficie de comandos, confirmar el objetivo y preparar diagnósticos antes de ejecutar una tarea con impacto.

doctor, tree, support, version, completion y las familias config y license están disponibles antes de la activación de la licencia o de la configuración completa de credenciales. Los comandos operativos como export, report, diff, search, import, rule e invoke requieren una licencia válida y credenciales de Jira.

Comandos de nivel superior

  • completion — genera scripts de autocompletado para shells compatibles. Se documenta más abajo.
  • config — gestiona la configuración de la aplicación. Consulta Comandos de configuración.
  • diff — compara dos directorios de exportación locales. Consulta Diff.
  • doctor — verifica configuración, credenciales, conectividad y permisos de escritura. Se documenta más abajo.
  • export — respalda cada regla de Jira Automation en JSON local. Consulta Exportar.
  • import — restaura o promueve reglas desde una exportación local. Consulta Importar.
  • invoke — dispara una regla de ejecución manual contra objetivos. Consulta Invocar.
  • license — gestiona tu licencia. Consulta Licencia.
  • report — genera reportes HTML autocontenidos. Consulta Reportes.
  • rule — operaciones masivas sobre reglas de Jira Automation. Consulta Reglas.
  • search — busca resúmenes de reglas en vivo mediante la API de Automation. Consulta Búsqueda.
  • support — genera un paquete de diagnóstico anonimizado para compartir con soporte. Se documenta más abajo.
  • tree — muestra el árbol completo de comandos con descripciones. Se documenta más abajo.
  • version — muestra la versión y los metadatos de compilación. Se documenta más abajo.

Doctor

ajat doctor [flags]

Ejecuta una secuencia de comprobaciones contra el entorno configurado para que cualquier mala configuración aflore antes de exportar reglas, mutar reglas o generar un reporte. doctor termina con 0 solo si pasan todas las comprobaciones.

Comprobaciones realizadas

ComprobaciónDescripción
ConfiguraciónValida la configuración efectiva
Archivo de licenciaConfirma que el archivo de licencia local existe y se descifra
Metadatos de licenciaValida los metadatos locales de licencia sin contactar con la API
Resolución del tenantResuelve el tenant vía /_edge/tenant_info (sin autenticación)
Credenciales de JiraPrueba las credenciales con /rest/api/3/myself
Acceso a la API AutomationPrueba el acceso a reglas manuales de Automation (Basic auth)
Directorio de salidaConfirma que el directorio de salida tiene permisos de escritura

Flags

FlagPredeterminadoDescripción
--output-dir<cwd>/jira_rule_exportsDirectorio de salida para probar permisos de escritura
--timeout30sTimeout global de las comprobaciones de doctor

Ejemplos

# Ejecuta todas las comprobaciones de diagnóstico
ajat doctor
 
# Valida un destino de exportación concreto antes de la primera ejecución
ajat doctor --output-dir ./jira-automations-backup
 
# Limita el tiempo total de ejecución
ajat doctor --timeout 10s

Momentos recomendados para ejecutar doctor:

  • inmediatamente después de activar la licencia
  • después de cambiar credenciales o configuración de proxy
  • antes de la primera exportación en una máquina nueva
  • antes de una exportación programada o visible para clientes

Usa el flag global --no-progress cuando necesites una salida más limpia en CI o en grabaciones de terminal.

completion

ajat completion [bash|zsh|fish|powershell]

Genera scripts de autocompletado para que los operadores recorran más rápido una superficie de comandos amplia.

Ejemplos

ajat completion zsh
ajat completion bash
ajat completion fish

Carga el autocompletado en la sesión de shell actual, por ejemplo con zsh:

source <(ajat completion zsh)

Pasa --no-descriptions para generar un script de autocompletado sin descripciones en línea. El autocompletado es especialmente útil para equipos que usan con frecuencia las familias de subcomandos config, report y rule y quieren descubrir opciones más rápido desde el shell.

support

ajat support [flags]

Genera un paquete de diagnóstico para compartir con el equipo de soporte.

El comando support recopila información del sistema, configuración, comprobaciones diagnósticas, variables de entorno y salida reciente del log en un único archivo. Los nombres de usuario de Jira, los API tokens y otros valores de entorno similares a secretos se anonimizan automáticamente, así que el paquete es seguro para compartir. El contenido del log se incluye tal cual, así que conviene revisarlo brevemente antes de compartirlo si tu configuración de logging puede capturar datos sensibles.

Flags

FlagShortPredeterminadoDescripción
--output-ostdoutEscribe el paquete en un archivo en lugar de stdout
--log-file-l(ninguno)Ruta del archivo de log que se incluirá en el paquete
--log-lines50Número de líneas recientes del log que se incluirán
--output-dir(ninguno)Directorio de salida para probar permisos de escritura

Contenido del paquete

  • Información del sistema: versión de la app, versión de Go, SO/arquitectura, commit y fecha de compilación
  • Configuración: ruta del archivo de config, dominio y tipo de Jira, ajustes HTTP y de log, con el token API anonimizado
  • Diagnóstico: las mismas comprobaciones que doctor
  • Entorno: solo variables AJAT_*, con secretos anonimizados
  • Log reciente: las últimas N líneas del archivo seleccionado

Ejemplos

# Imprimir el paquete por stdout
ajat support
 
# Guardar el paquete en un archivo
ajat support --output support-bundle.txt
 
# Incluir más contexto del log
ajat support --log-file app.log --log-lines 200

Consejo: reproduce primero el problema con logging en modo debug y después genera el paquete:

# 1. Reproducir el problema con debug
ajat export --output-dir ./jira-automations-backup --debug --log-file app.log
 
# 2. Generar el paquete de soporte
ajat support --log-file app.log --output support-bundle.txt

Adjunta la salida al contactar con support@climakers.com. Consulta Soporte para el flujo completo de diagnóstico.

Tree

ajat tree [flags]

Imprime el árbol completo de comandos con descripciones. Es útil para descubrir los comandos disponibles y su jerarquía de un vistazo sin recorrer las páginas de ayuda individuales.

Flags

FlagShortPredeterminadoDescripción
--short-sfalseOculta los flags y muestra solo los comandos con descripción

Ejemplos

# Muestra el árbol completo de comandos con flags
ajat tree
 
# Oculta los flags y muestra solo los comandos
ajat tree --short

Salida de tree --short

La forma corta muestra comandos y descripciones sin flags — útil para runbooks de operadores y onboarding:

ajat
├── completion                          →  Generate the autocompletion script for the specified shell
│   ├── bash                            →  Generate the autocompletion script for bash
│   ├── fish                            →  Generate the autocompletion script for fish
│   ├── powershell                      →  Generate the autocompletion script for powershell
│   └── zsh                             →  Generate the autocompletion script for zsh
├── config                              →  Manage the ajat configuration file
│   ├── create                          →  Create the configuration file with default settings
│   ├── get                             →  Show the value of a single configuration setting
│   ├── list                            →  Show the effective configuration as YAML
│   ├── set                             →  Save a configuration setting to the config file
│   ├── validate                        →  Check the effective configuration for problems
│   └── where                           →  Print the path to the configuration file
├── diff                                →  Diff two ajat export directories without calling the Jira API
├── doctor                              →  Verify configuration, Jira reachability, and write permissions
├── export                              →  Back up every Automation rule to local JSON (full or incremental)
├── import                              →  Restore Automation rules from a local backup into Jira
├── invoke                              →  Fire a manually-triggered Automation rule against targets
├── license                             →  Activate, inspect, and manage the ajat license
│   ├── activate                        →  Activate a license on this machine
│   ├── deactivate                      →  Deactivate the license and free its activation seat
│   ├── export                          →  Export the encrypted license to a backup file
│   ├── import                          →  Import a license from a backup file
│   ├── list                            →  Show the current license details
│   ├── terms                           →  Print the software license agreement
│   ├── validate                        →  Verify that the current license is valid
│   └── where                           →  Print the license file path
├── report                              →  Generate self-contained HTML reports over the automation inventory
│   ├── collision                       →  Find overlapping and behaviourally-duplicate rules
│   ├── consistency                     →  Audit label hygiene, naming, ownership and consistency
│   ├── inventory                       →  Catalogue every Automation rule by scope, with flow diagrams
│   ├── risk                            →  Score governance & operational risk across the estate
│   └── workflow                        →  Render every rule as a flow-diagram runbook
├── rule                                →  Apply bulk operations to Jira Automation rules
│   ├── delete                          →  Delete disabled rules matched by the selector
│   ├── disable                         →  Disable rules matched by the selector
│   ├── enable                          →  Enable rules matched by the selector
│   ├── manual                          →  Work with manually-triggered Jira Automation rules
│   │   └── list                        →  List manually-triggered rules applicable to one or more targets
│   └── scope                           →  Change the rule-scope of rules matched by the selector
│       └── set                         →  Replace, add, or remove scope ARIs on matched rules
├── search                              →  Search live Automation rules in Jira, no export needed
├── support                             →  Generate a diagnostic bundle for support
├── tree                                →  Display the full command tree with descriptions
└── version                             →  Print the ajat version

Salida de tree (completa)

Sin --short, el árbol completo también muestra todos los flags de cada comando, incluyendo formas cortas, descripciones y valores predeterminados. Esto es útil para buscar flags rápidamente sin ejecutar --help en comandos individuales.

Usa tree --short cuando necesites un inventario compacto de la versión para runbooks, onboarding o documentación interna de operaciones. Usa tree (completo) cuando necesites una referencia completa de todos los flags disponibles.

version

ajat version [flags]

Imprime la versión del binario de ajat.

Flags

FlagPredeterminadoDescripción
--extendedfalseImprime metadatos extendidos de compilación

Ejemplos

# Versión corta
ajat version
 
# Metadatos completos de compilación: fecha, commit, rama, builder y toolchain de Go
ajat version --extended

El flag global --version-extended imprime los mismos metadatos extendidos desde cualquier invocación sin el subcomando version.

Last updated on
SoporteTérminos de Licencia