CLI
Command ReferenceLast updated on
Last updated on
Complete reference for all Paradoc CLI commands
The Paradoc CLI provides commands for working with registries, authoring and rendering artifacts, managing projects, and configuring the CLI. The groups below match the output of paradoc --help.
Usage
paradoc <command> [options]Global options:
| Option | Description |
|---|---|
-h, --help | Display help for a command |
-v, --version | Display CLI version |
--no-telemetry | Disable telemetry for this invocation |
Registry
Commands for discovering and installing artifacts from registries.
| Command | Description |
|---|---|
| add | Add an artifact from a registry, or a document component or block |
| list | List installed artifacts (alias: ls) |
| search | Search for artifacts in a registry |
| registry | Manage registry configurations |
Artifacts
Commands for creating, inspecting, rendering, and changing artifacts.
| Command | Description |
|---|---|
| show | Show details about an artifact |
| validate | Validate artifacts against the core schema |
| inspect | Inspect PDF form fields to aid in bindings configuration |
| render | Render an artifact layer |
| check | Check a React composition against its artifact without rendering |
| new | Create a new artifact (form, document, checklist, bundle) |
| fix | Fix artifact metadata, such as layer checksums |
| version | Bump the semantic version in an artifact file |
| attach | Attach a file as a layer to an artifact |
| detach | Detach a layer from an artifact |
| generate | Generate TypeScript types from artifacts |
| hash | Compute SHA256 checksums for layer definitions |
| data | Data operations (fill, template, validate, extract) |
| diff | Show differences between two artifact files |
| migrate | Migrate artifact files to the current schema version |
Project
Commands for initializing and working in Paradoc projects.
| Command | Description |
|---|---|
| init | Initialize a new Paradoc project |
| dev | Preview React compositions live beside their PDF |
| apply | Apply a unified diff patch to the working directory |
Settings
Commands for configuring the CLI and opening related resources.