Skip to Content

Utilidades

Esta página documenta los comandos de primer nivel expuestos actualmente por acp2md tree, ademas de las utilidades usadas para diagnostico y descubrimiento.

Estos comandos importan porque definen el flujo operativo seguro alrededor del producto. En produccion y soporte, deben formar parte del runbook, no ser una ocurrencia tardia.

Comandos de primer nivel

  • config — gestiona la configuración de la aplicacion. Ve Comandos de configuración.
  • completion — genera scripts de autocompletado para shells compatibles. Se documenta mas abajo.
  • doctor — verifica configuración, credenciales y conectividad. Se documenta mas abajo.
  • license — gestiona tu licencia. Ve Licencia.
  • page — trabaja con páginas individuales de Confluence. Ve Convertir páginas, Recuperar páginas, Conteo y análisis y Propiedades de página.
  • space — descubre espacios y lista páginas antes de convertir una página concreta. Estas capacidades siguen la misma interfaz documentada en Listar espacios y Listar páginas.
  • support — genera un paquete de diagnostico para compartir con soporte. Se documenta mas abajo.
  • tree — muestra el árbol completo de comandos con descripciones. Se documenta mas abajo.

doctor

acp2md doctor [flags]

Ejecuta una serie de comprobaciones diagnósticas para verificar que acp2md está correctamente configurado y listo para usarse. Es la forma más rápida de diagnosticar problemas de configuración inicial.

Se realizan las siguientes comprobaciones:

ComprobacionDescripcion
Archivo de configuraciónVerifica que el archivo de configuración existe y se puede leer
Credenciales de ConfluenceConfirma que el dominio, el usuario y el token API están definidos
Conectividad APIPrueba la conexion con la API REST de Confluence
Archivo de licenciaComprueba que hay una licencia válida
ID de máquinaVerifica el identificador de máquina usado para vincular la licencia
Información de versiónMuestra la versión actual de acp2md, la fecha de compilacion y el commit

Ejemplo

acp2md doctor

Salida de ejemplo de una ejecución real en macOS, con datos anonimizados:

🩺 Running diagnostics for acp2md v1.0.0... ✅ Configuration file /Users/<user>/Library/Application Support/acp2md/config.yaml ✅ Confluence credentials <tenant>.atlassian.net (user: <redacted>) ✅ Confluence API connected (212ms) ✅ License file loaded (<redacted>) ✅ Machine ID <redacted> ✅ Versión acp2md v1.0.0 (darwin/arm64, built 2026-03-29T08:23:49Z) 📊 Result: all 6 checks passed 🎉 acp2md is ready to use!

Ejecuta acp2md doctor como primer paso al investigar cualquier incidencia. La salida indicara que componente requiere atencion.

Momentos recomendados para ejecutar doctor:

  • inmediatamente despues de activar la licencia
  • despues de cambiar credenciales o configuración de proxy
  • antes de la primera exportación en una máquina nueva
  • antes de una ejecución orientada al cliente o sensible al tiempo

En v1.0.0, doctor no expone flags propios del subcomando. Usa el flag global --no-progress cuando necesites una salida mas limpia en CI o en grabaciones.


completion

acp2md completion [bash|zsh|fish|powershell]

Genera scripts de autocompletado para que los operadores descubran comandos y flags mas rápido desde la terminal.

powershell aqui se refiere solo a la generacion del script de autocompletado. No implica que exista actualmente una versión para Windows.

Ejemplos

acp2md completion zsh acp2md completion bash

Usa completion cuando quieras una experiencia operativa local mas fluida, especialmente con rutas largas de subcomandos y trabajo repetido de soporte u operaciones.


support

acp2md support [flags]

Genera un paquete de diagnostico para compartir con el equipo de soporte.

El comando support recopila información del sistema, configuración, comprobaciones diagnosticas, variables de entorno y salida reciente del log en un unico archivo. Las credenciales presentes en la configuración y en las variables de entorno se anonimizan automáticamente. El contenido del log se incluye tal cual, asi que conviene revisarlo brevemente antes de compartirlo si tu configuración de logging puede capturar datos sensibles.

Flags

FlagShortPredeterminadoDescripcion
--output-ostdoutEscribe el paquete en un archivo en lugar de stdout
--log-file-ldesde configRuta del archivo de log que se incluira en el paquete
--log-lines50Numero de lineas recientes del log que se incluiran

Contenido del paquete

  • Información del sistema: versión de la app, versión de Go, SO/arquitectura, commit y fecha de compilacion
  • Configuración: ruta del archivo de config, dominio y tipo de Confluence, ajustes HTTP y de log, con el token API anonimizado
  • Diagnostico: las mismas comprobaciones que doctor
  • Entorno: solo variables ACP2MD_*, con secretos anonimizados
  • Log reciente: las ultimas N lineas del archivo seleccionado

Ejemplos

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

Consejo: reproduce primero el problema con logging en modo debug y despues genera el paquete:

# 1. Reproducir el problema con debug acp2md page convert by-id 123456 --debug --log-file app.log # 2. Generar el paquete de soporte acp2md support --log-file app.log --output bundle.txt

Usa support cuando necesites un unico artefacto compartible que ya incluya el contexto mas relevante de entorno, configuración y diagnostico.


tree

acp2md tree [flags]

Muestra el árbol completo de comandos con descripciones. Es una forma rápida de descubrir todos los comandos y subcomandos disponibles sin leer toda la documentación.

Flags

FlagShortPredeterminadoDescripcion
--short-sfalseOculta los flags y muestra solo comandos con descripciones

Ejemplo

acp2md tree acp2md tree --short

Salida de tree --short

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

acp2md → Convert Atlassian Confluence pages to Markdown ├── config → Manage application configuration │ ├── create → Create the default configuration file │ ├── get → Get a configuration value by key │ ├── list → List all configuration values │ ├── set → Set a configuration value │ └── where → Show the location of the configuration file ├── doctor → Verify configuration, credentials, and connectivity ├── license → Manage your license │ ├── activate → Activate a license for the application │ ├── deactivate → Deactivate the license for this instance │ ├── export → Export the license file to a backup location │ ├── import → Import a license file from a backup │ ├── list → Display license information │ ├── validate → Validate the application license │ └── where → Show the location of the license file ├── page → Work with individual Confluence pages │ ├── convert → Convert pages to Markdown │ │ ├── by-id → Convert a page to Markdown by its ID │ │ ├── by-title → Convert a page to Markdown by its title │ │ └── by-url → Convert a page to Markdown by its Confluence URL │ ├── count → Analyze page structure and complexity │ │ ├── marks → Count ADF formatting marks │ │ │ ├── by-id → Count formatting marks by page ID │ │ │ ├── by-title → Count formatting marks by page title │ │ │ └── by-url → Count formatting marks by Confluence URL │ │ └── nodes → Count ADF content nodes │ │ ├── by-id → Count content nodes by page ID │ │ ├── by-title → Count content nodes by page title │ │ └── by-url → Count content nodes by Confluence URL │ ├── get → Retrieve pages in native Confluence formats │ │ ├── by-id → Retrieve a page in native format by its ID │ │ ├── by-title → Retrieve a page in native format by its title │ │ └── by-url → Retrieve a page in native format by its URL │ └── properties → List custom properties of a page │ ├── by-id → List page properties by page ID │ ├── by-title → List page properties by page title │ └── by-url → List page properties by Confluence URL ├── space → Work with Confluence spaces │ ├── list → List all accessible Confluence spaces │ └── pages → List pages in a space │ ├── by-id → List pages by space ID │ └── by-key → List pages by space key ├── support → Generate a diagnostic bundle for support └── tree → Display the full command tree with descriptions

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 rapidamente sin ejecutar --help en comandos individuales.

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

Last updated on