Skip to Content

Utilidades

Esta página documenta los comandos de nivel superior que acs2md tree expone actualmente, ademas de los comandos de utilidad usados para diagnostico y descubrimiento.

Estos comandos enmarcan el flujo operativo seguro para una exportación masiva: validar la estacion de trabajo, inspeccionar la superficie de comandos y confirmar el objetivo antes de ejecutar una tarea con impacto.

Comandos de nivel superior


Doctor

acs2md doctor [flags]

Ejecuta una serie de comprobaciones de diagnostico y muestra los resultados. Usalo para verificar la instalación antes de ejecutar una conversion.

Comprobaciones realizadas

ComprobacionDescripcion
ConfigVerifica que exista un archivo de configuración y que sea válido
CredentialsConfirma que el dominio de Confluence, el usuario y el API token esten definidos
Conectividad APIPrueba una conexion real con la API REST de Confluence
LicenseValida el estado actual de la licencia
ID de máquinaVerifica que se pueda generar un identificador de máquina estable
VersiónMuestra la versión actual de acs2md, la fecha de compilacion y el commit

Ejemplos

# Ejecuta todas las comprobaciones de diagnostico acs2md doctor # Los aliases funcionan igual acs2md check acs2md diag

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

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

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 masiva en una máquina nueva
  • antes de una exportación programada o visible para clientes

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


completion

acs2md completion [bash|zsh|fish|powershell]

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

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

Ejemplos

acs2md completion zsh acs2md completion bash

El autocompletado es especialmente útil para equipos que usan con frecuencia subcomandos space y page y quieren descubrir opciones mas rápido desde el shell.


support

acs2md 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 ACS2MD_*, con secretos anonimizados
  • Log reciente: las ultimas N lineas del archivo seleccionado

Ejemplos

# Imprimir el paquete por stdout acs2md support # Guardar el paquete en un archivo acs2md support --output bundle.txt # Incluir mas contexto del log acs2md 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 acs2md space convert by-key MYSPACE --output-dir output --debug --log-file app.log # 2. Generar el paquete de soporte acs2md 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

acs2md tree [flags]

Imprime el árbol completo de comandos con descripciones. Es útil para descubrir los comandos disponibles y su jerarquia.

Flags

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

Ejemplos

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

Salida de tree --short

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

acs2md → Convert Atlassian Confluence spaces 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 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 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 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 URL ├── space → Work with Confluence spaces │ ├── convert → Convert all pages in a space to Markdown │ │ ├── by-id → Convert a space to Markdown by its ID │ │ └── by-key → Convert a space to Markdown by its key │ ├── get → Download space pages in native format │ │ ├── by-id → Download space pages in native format by ID │ │ └── by-key → Download space pages in native format by key │ ├── 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 │ ├── permissions → List access permissions for a space │ │ ├── by-id → List space permissions by space ID │ │ └── by-key → List space permissions by space key │ └── properties → List custom properties of a space │ ├── by-id → List space properties by space ID │ └── by-key → List space properties 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 runbooks, onboarding o documentación interna de operaciones. Usa tree (completo) cuando necesites una referencia completa de todos los flags disponibles.

Last updated on