CLICommands
dataLast updated on
Last updated on
Data operations for artifacts
Data operations for OpenForm artifacts.
Usage
ofm data <command> [options]Subcommands
| Command | Description |
|---|---|
template | Generate an instance template from a form |
fill | Interactively fill form data |
validate | Validate data against a form schema |
data template
Generate an instance template from a form artifact.
ofm data template <file> [options]Arguments
| Argument | Description |
|---|---|
file | Form artifact file (JSON/YAML) |
Options
| Option | Description |
|---|---|
--out <file> | Output file path (format detected from extension) |
--json | Force JSON output format |
--yaml | Force YAML output format |
--silent | Suppress console output |
Examples
Generate template to stdout:
ofm data template my-form.yamlGenerate template to file:
ofm data template my-form.yaml --out data.yamlOutput
fields:
address: null
monthlyRent: null
startDate: null
endDate: nulldata fill
Interactively fill form data and save to an output file.
ofm data fill <file> --out <file>Arguments
| Argument | Description |
|---|---|
file | Form artifact file (JSON/YAML) |
Options
| Option | Description |
|---|---|
--out <file> | Output file path (required) |
--json | Force JSON output format |
--yaml | Force YAML output format |
Description
The fill command walks you through each field in the form with interactive prompts. Field types are validated, and complex types (like addresses or money) can be entered as JSON.
Example
ofm data fill my-form.yaml --out filled-data.yamlInteractive session:
Fill Form: Residential Lease Agreement
? Address: 123 Main St
? Monthly Rent (Enter as JSON): {"amount": 1500, "currency": "USD"}
? Start Date: 2025-02-01
? End Date: 2026-01-31
✓ Form data saved
Output: filled-data.yaml
Format: YAMLdata validate
Validate data against a form's schema.
ofm data validate <form> <data>Arguments
| Argument | Description |
|---|---|
form | Form artifact file |
data | Data file to validate |