# Command Reference

Complete reference for all Paradoc CLI commands

Canonical URL: https://docs.paradoc.dev/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

```bash
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](/cli/commands/add)           | Add an artifact from a registry, or a document component or block |
| [list](/cli/commands/list)         | List installed artifacts (alias: `ls`)                            |
| [search](/cli/commands/search)     | Search for artifacts in a registry                                |
| [registry](/cli/commands/registry) | Manage registry configurations                                    |

## Artifacts

Commands for creating, inspecting, rendering, and changing artifacts.

| Command                            | Description                                                      |
| ---------------------------------- | ---------------------------------------------------------------- |
| [show](/cli/commands/show)         | Show details about an artifact                                   |
| [validate](/cli/commands/validate) | Validate artifacts against the core schema                       |
| [inspect](/cli/commands/inspect)   | Inspect PDF form fields to aid in bindings configuration         |
| [render](/cli/commands/render)     | Render an artifact layer                                         |
| [check](/cli/commands/check)       | Check a React composition against its artifact without rendering |
| [new](/cli/commands/new)           | Create a new artifact (form, document, checklist, bundle)        |
| [fix](/cli/commands/fix)           | Fix artifact metadata, such as layer checksums                   |
| [version](/cli/commands/version)   | Bump the semantic version in an artifact file                    |
| [attach](/cli/commands/attach)     | Attach a file as a layer to an artifact                          |
| [detach](/cli/commands/detach)     | Detach a layer from an artifact                                  |
| [generate](/cli/commands/generate) | Generate TypeScript types from artifacts                         |
| [hash](/cli/commands/hash)         | Compute SHA256 checksums for layer definitions                   |
| [data](/cli/commands/data)         | Data operations (fill, template, validate, extract)              |
| [diff](/cli/commands/diff)         | Show differences between two artifact files                      |
| [migrate](/cli/commands/migrate)   | Migrate artifact files to the current schema version             |

## Project

Commands for initializing and working in Paradoc projects.

| Command                      | Description                                         |
| ---------------------------- | --------------------------------------------------- |
| [init](/cli/commands/init)   | Initialize a new Paradoc project                    |
| [dev](/cli/commands/dev)     | Preview React compositions live beside their PDF    |
| [apply](/cli/commands/apply) | Apply a unified diff patch to the working directory |

## Settings

Commands for configuring the CLI and opening related resources.

| Command                              | Description                                        |
| ------------------------------------ | -------------------------------------------------- |
| [configure](/cli/commands/configure) | Interactive configuration wizard (alias: `config`) |
| [cache](/cli/commands/cache)         | Manage registry cache                              |
| [reset](/cli/commands/reset)         | Reset CLI to factory defaults                      |
| [docs](/cli/commands/docs)           | Open documentation in browser                      |
| [console](/cli/commands/console)     | Open web console                                   |
| [about](/cli/commands/about)         | Display information about Paradoc                  |