CLICommands
Command ReferenceLast updated on
Last updated on
Complete reference for all OpenForm CLI commands
The OpenForm CLI provides commands for managing projects, working with registries, authoring artifacts, and more.
Usage
ofm <command> [options]Global options:
| Option | Description |
|---|---|
-h, --help | Display help for a command |
-v, --version | Display CLI version |
Project
Commands for initializing and managing OpenForm projects.
| Command | Description |
|---|---|
| init | Initialize a new OpenForm project |
Registry
Commands for discovering and installing artifacts from registries.
| Command | Description |
|---|---|
| add | Add an artifact from a registry |
| search | Search for artifacts in registries |
| list | List installed artifacts |
| registry | Manage registry configurations |
Authoring
Commands for creating and modifying artifacts.
| Command | Description |
|---|---|
| new | Create a new artifact (form, checklist, document, bundle) |
| validate | Validate artifacts against schemas |
| fix | Auto-fix common artifact issues |
| version | Bump artifact version numbers |
| attach | Attach files to artifacts as layers |
| detach | Detach a layer from an artifact |
| generate | Generate TypeScript types from artifacts |
| hash | Compute SHA256 checksums for layer definitions |
Working with artifacts
Commands for inspecting, rendering, and working with artifact data.
| Command | Description |
|---|---|
| inspect | Inspect artifact structure and metadata |
| render | Render an artifact layer to output |
| show | Display artifact content |
| data | Data operations (fill, template) |
| diff | Compare two artifacts |
| apply | Apply changes to artifacts |
Settings
Commands for configuring the CLI.
| Command | Description |
|---|---|
| configure | Interactive configuration wizard |
| cache | Manage registry cache |
| renderers | Manage renderer plugins |
| reset | Reset CLI to factory defaults |
Utility
Helpful utility commands.