Paradoc
CLI

About CLI

Last updated on

Command-line interface for managing Paradoc artifacts

The Paradoc CLI (para) is a command-line tool for working with Paradoc artifacts — structured definitions of forms, documents, checklists, and bundles. It takes a registry-first approach: discover and install pre-built artifacts from shared registries, then validate, render, and manage them locally. It's also an authoring tool for creating new artifacts from scratch.

Key capabilities

  • Install artifacts from public or private registries
  • Create new artifacts (forms, documents, checklists, bundles)
  • Validate artifacts against the Paradoc JSON Schema
  • Render layers to PDF, DOCX, or Markdown
  • Diff and patch artifacts
  • Build and host your own registries
  • Generate TypeScript types from artifacts

Installation

npm install -g paradoc
pnpm add -g paradoc
yarn global add paradoc
bun add -g paradoc

Verify the installation:

paradoc --version

The package registers two commands: paradoc and the shorthand alias para. Both are identical — use whichever you prefer. These docs use para throughout for brevity.

Next steps

  • Projects - Project structure, manifest, lock file, and output formats
  • Configuration - Global and project settings, environment variables, renderers, and cache
  • Registries - Consuming and creating artifact registries
  • Command reference - Full list of available commands

On this page