CLI
Comandos
Todos los comandos de dxcl, con los flags que importan.
La CLI es dxcl y viene dentro del paquete docxcelerate. Ejecútala de forma
puntual con npx docxcelerate <command>, o instala el paquete y llama a dxcl
directamente — consulta Empieza aquí.
dxcl init
Crea un workspace e instala sus dependencias.
dxcl init my-documents
dxcl init my-documents --dir workspaces
dxcl init my-documents --blankEjecútalo sin argumentos para una configuración guiada que pregunta por la plantilla y por el endpoint de la API.
| Flag | Efecto |
|---|---|
--dir <path> | Crear el workspace dentro de <path> |
--blank | Omitir el documento de ejemplo |
--official-server | Apuntar upload.endpoint al motor oficial |
--api-endpoint <url> | Apuntar upload.endpoint a tu propio servicio |
--no-api-endpoint | Dejar upload.endpoint vacío |
dxcl document new
Crea un proyecto de documento dentro de un workspace.
dxcl document new tenancy-renewal --title "Tenancy Renewal"Escribe documents/tenancy-renewal/ con document.project.ts, document.tsx,
document-style.ts, preview-data.ts, types.ts y los directorios derivers/
y nodes/. Mira proyectos de documento para saber
para qué sirve cada archivo.
dxcl document node
Genera un componente de nodo y lo registra.
dxcl document node documents/tenancy-renewal next-steps --type paragraph
dxcl document node documents/tenancy-renewal signature --type image
dxcl document node documents/tenancy-renewal rent-trend --type graph| Flag | Valores |
|---|---|
--type | paragraph, image, graph |
El generador escribe nodes/<name>.node.tsx y actualiza nodes/index.ts. No
coloca el nodo en tu plantilla — añádelo a document.tsx en el punto del
documento donde le corresponde.
El nodo que escribe empieza con su contenido. Lo que hace que un nodo sea generado es ponerle prompts, y eso lo decide un componente con los datos en la mano — así que aquí no hay nada que elegir. Mira escribir nodos.
dxcl list
Imprime el registro: todos los temas y todos los componentes prefabricados que trae el paquete.
dxcl list
dxcl list themes
dxcl list componentsEl mismo catálogo se puede recorrer en temas y componentes, donde cada entrada lleva una vista previa generada por el mismo renderizador que trae la CLI.
dxcl show
Imprime una entrada completa — qué es, qué lee y dónde acaban sus archivos.
dxcl show slate-report
dxcl show payment-summarydxcl add
Instala temas y componentes en un proyecto de documento.
dxcl add slate-report
dxcl add letterhead signature-block
dxcl add payment-summary --project documents/arrears-notice| Flag | Efecto |
|---|---|
--project <dir> | El proyecto de documento en el que instalar |
--force | Sobrescribir archivos que ya estén ahí |
Sin --project, el comando usa el proyecto de documento en el que estás, o el
único que haya bajo documents/. Cuando hay varios y ninguno está implícito, lo
dice en lugar de adivinar.
Un componente se copia como código fuente — nodes/<name>.node.tsx — y se
re-exporta desde nodes/index.ts. A partir de ahí es tu archivo: no tiene
versión, nunca se actualiza a tus espaldas, y editarlo es el siguiente paso
previsto y no un fork. Lo que no hace es editar tu tipo de datos, así que los
campos que el componente lee se imprimen para que los añadas. Colocarlo en
document.tsx también es cosa tuya, por la misma razón por la que el generador
de nodos no lo toca.
Un tema se escribe como el document-style.ts del proyecto, que
document.project.ts ya pasa a través — así que la siguiente vista previa sale
con el tema puesto. El archivo importa el tema y lo expande, de modo que
sobrescribir un margen es una línea y no un fork:
export const documentStyle: DocumentStyle = themeStyle(slateReportTheme, {
page: { margins: { topMm: 20 } },
});Instalar un segundo tema reemplaza un document-style.ts que nadie ha tocado.
Una vez que has escrito en él, reemplazarlo requiere --force — la gracia del
archivo es justamente que es tuyo.