Descripción general de comandos

Comando Función técnica
npx @docmd/core init Inicializar un nuevo espacio de trabajo de documentación.
npx @docmd/core dev Iniciar el servidor de desarrollo local con recarga rápida.
npx @docmd/core build Compilar un sitio estático listo para producción.
npx @docmd/core live Iniciar el entorno del Editor en vivo basado en el navegador.
npx @docmd/core stop Finalizar los servidores de desarrollo activos.
npx @docmd/core deploy Generar manifiestos de despliegue y archivos de contenedor.
npx @docmd/core migrate Actualizar configuraciones heredadas o migrar desde herramientas de terceros.
npx @docmd/core validate Ejecutar la validación de enlaces y comprobar la integridad del documento Markdown.
npx @docmd/core doctor Ejecutar diagnósticos de entorno previos al vuelo e inspeccionar dependencias.
npx @docmd/core mcp Ejecutar el servidor del Protocolo de Contexto de Modelo (MCP) a través de stdio.
npx @docmd/core add <plugin> Instalar y configurar plugins de docmd.
npx @docmd/core remove <plugin> Desinstalar plugins y eliminar entradas de configuración.

Opciones globales

Marcador de parámetro Alias Descripción técnica
--config <path> -c Especificar ruta personalizada al archivo de configuración (predeterminado: docmd.config.json).
--verbose -V Emitir registros de ejecución detallados.
--version -v Emitir la versión del paquete instalado.
--help -h Emitir instrucciones de ayuda de la CLI de comandos.
--cwd <path> - Anular la ruta del directorio de trabajo de destino.

npx @docmd/core init

Inicializa un diseño de repositorio de documentación dentro del directorio de trabajo.

npx @docmd/core init

Genera:

  • docs/index.md: página de inicio predeterminada.
  • docmd.config.json: opciones de configuración estándar.
  • Scripts de compilación de package.json actualizados.

npx @docmd/core dev

Inicia el servidor de desarrollo local con recarga rápida en tiempo real.

npx @docmd/core dev [opciones]
Marcador de parámetro Alias Descripción técnica
--port <number> -p Especificar puerto del servidor web (predeterminado: 3000).
--config <path> -c Ruta personalizada al archivo de configuración.

npx @docmd/core build

Compila un sitio estático de producción en su directorio de salida configurado (site/).

npx @docmd/core build [opciones]
Marcador de parámetro Alias Descripción técnica
--offline - Reescribir rutas de recursos y enlaces a archivos relacionales .html para la navegación local en el sistema de archivos.
--config <path> -c Ruta personalizada al archivo de configuración.

npx @docmd/core live

Inicia el entorno del Editor en vivo basado en el navegador.

npx @docmd/core live [opciones]
Marcador de parámetro Descripción técnica
--build-only Compilar el paquete independiente del Editor en vivo sin iniciar el servidor web de vista previa.

npx @docmd/core stop

Finaliza los servidores de desarrollo en ejecución.

npx @docmd/core stop [opciones]
Marcador de parámetro Alias Descripción técnica
--port <number> -p Finalizar el proceso que se ejecuta en el puerto especificado.
--force -f Forzar la detención de procesos que se ejecutan en puertos estándar (3000, 3001, 8080, 8081).

npx @docmd/core deploy

Genera manifiestos de despliegue y archivos de configuración.

npx @docmd/core deploy [opciones]
Marcador de parámetro Descripción técnica
--docker Emitir Dockerfile multietapa y .dockerignore.
--nginx Emitir nginx.conf para producción.
--caddy Emitir Caddyfile.
--github-pages Emitir .github/workflows/deploy.yml.
--vercel Emitir vercel.json.
--netlify Emitir netlify.toml.
--force Sobrescribir los manifiestos de despliegue existentes.

npx @docmd/core migrate

Migra configuraciones desde versiones heredadas o motores de terceros.

npx @docmd/core migrate [opciones]

Marcadores de opción:

  • --upgrade: Traducir las claves de configuración heredadas anteriores a 0.7.x en el lugar.
  • --dry-run: Previsualizar los cambios de migración sin modificar el contenido del disco.

npx @docmd/core validate

Valida los destinos de enlaces internos y la estructura de documentos en las fuentes Markdown.

npx @docmd/core validate [opciones]
Marcador de parámetro Descripción técnica
--json Emitir errores de validación como JSON legible por máquina para la integración con CI.

npx @docmd/core doctor

Ejecuta diagnósticos de entorno previos al vuelo e inspecciona los estados de instalación de plugins/plantillas.

npx @docmd/core doctor [opciones]
Marcador de parámetro Descripción técnica
--config <path> Ruta a un archivo de configuración que no sea el predeterminado.
--fix Autoinstalar plugins o plantillas oficiales que falten e identificados durante la comprobación.
--json Emitir el informe de diagnóstico en formato JSON legible por máquina.

npx @docmd/core mcp

Ejecuta el servidor del Protocolo de Contexto de Modelo (MCP) a través de stdio para integraciones de agentes.

npx @docmd/core mcp
claude_desktop_config.json
{
  "mcpServers": {
    "docmd": {
      "command": "npx",
      "args": ["-y", "@docmd/core", "mcp"]
    }
  }
}

npx @docmd/core add <plugin>

Instala y configura plugins oficiales o de terceros.

npx @docmd/core add <nombre-del-plugin>
Ejemplo de comando Función técnica
npx @docmd/core add analytics Instalar @docmd/plugin-analytics.
npx @docmd/core add search Instalar @docmd/plugin-search.

npx @docmd/core remove <plugin>

Desinstala plugins y limpia los bloques de configuración correspondientes en docmd.config.json.

npx @docmd/core remove <nombre-del-plugin>
Registro de terminal para agentes

docmd da formato a la salida de la CLI mediante registros de terminal estructurados para simplificar el análisis por parte de trabajos de CI automatizados y agentes de desarrollo de IA.

Anterior Firebase Siguiente API del Navegador