OpenForm
CLICommands

new

Last updated on

Create new OpenForm artifacts

Creates new OpenForm artifacts with interactive prompts or command-line options.

Usage

ofm new <type> <name> [options]

Subcommands

CommandDescription
formCreate a new form artifact
documentCreate a new document artifact
checklistCreate a new checklist artifact
bundleCreate a new bundle artifact

new form

Create a new form artifact.

ofm new form <name> [options]

Options

OptionDescription
-y, --yesNon-interactive mode (skip prompts)
--slug <slug>Override auto-generated slug
--title <title>Human-readable title
--description <desc>Description
--code <code>Code/reference
--artifact-version <version>Version (default: 1.0.0)
--dir <path>Custom output directory
--field <name:type>Add field (can be used multiple times)
--dry-runPreview without creating files
--format <format>Output format: json or yaml (default: json)

Examples

Interactive form creation:

ofm new form my-form

Non-interactive with options:

ofm new form lease-agreement \
  --yes \
  --title "Lease Agreement" \
  --field "address:address" \
  --field "rent:money" \
  --format yaml

new document

Create a new document artifact.

ofm new document <name> [options]

Options

OptionDescription
-y, --yesNon-interactive mode
--slug <slug>Override auto-generated slug
--format <format>Output format: json or yaml
--dry-runPreview without creating files

new checklist

Create a new checklist artifact.

ofm new checklist <name> [options]

Options

OptionDescription
-y, --yesNon-interactive mode
--slug <slug>Override auto-generated slug
--format <format>Output format: json or yaml
--dry-runPreview without creating files

new bundle

Create a new bundle artifact.

ofm new bundle <name> [options]

Options

OptionDescription
-y, --yesNon-interactive mode
--slug <slug>Override auto-generated slug
--format <format>Output format: json or yaml
--dry-runPreview without creating files

See also

  • validate - Validate created artifacts
  • fix - Fix artifact issues

On this page