OpenForm
CLICommandsregistry

registry make

Last updated on

Create a new registry.json file

Create a new registry.json file for hosting your own artifact registry.

Usage

ofm registry make [directory] [options]

Arguments

ArgumentDescription
directoryDirectory to create registry in (default: current directory)

Options

OptionDescription
-n, --name <name>Registry name
--description <description>Registry description
--homepage <url>Registry homepage URL
--artifacts-path <path>Path prefix for artifacts (default: /r)
--no-telemetryDisable usage telemetry for this registry
--no-directoryDo not list this registry in the OpenForm Hub
-y, --yesSkip confirmation prompts

Description

Creates a registry.json file that defines a new artifact registry. This is the first step in hosting your own OpenForm registry. The command prompts for a name and description interactively, or you can pass them via options.

Examples

Create a registry interactively:

ofm registry make

Create in a specific directory with options:

ofm registry make ./my-registry \
  --name "Acme Forms" \
  --description "Internal form templates" \
  --homepage https://acme.com/forms \
  -y

Next steps

After creating a registry:

  1. Add artifacts with ofm registry catalog add <artifact>
  2. Compile the registry with ofm registry compile
  3. Deploy the output directory to your hosting provider

See also

On this page