registry make

Last updated on

Create a new registry.config.json file

Create a new registry.config.json file, the source file of your own artifact registry.

Usage

paradoc 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
--no-registry-telemetryDisable usage telemetry for this registry
--no-directoryDo not list this registry in the Paradoc Hub
-y, --yesSkip confirmation prompts

Description

Creates registry.config.json, the file you list your artifact files in. This is the first step in hosting your own Paradoc registry. registry compile builds the registry from it: registry.json and a folder for each release. The command prompts for a name, description, and homepage interactively, or you can pass them via options. See Registry config for every field.

Examples

Create a registry interactively:

paradoc registry make

Create in a specific directory with options:

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

Output

✓ Created registry.config.json

Name: acme-forms
Homepage: https://acme.com/forms
Description: Internal form templates

Next steps:
  1. Add artifacts with: paradoc registry catalog add <artifact>
  2. Compile registry with: paradoc registry compile

The new file has no source files yet:

{
  "name": "acme-forms",
  "homepage": "https://acme.com/forms",
  "description": "Internal form templates",
  "enableTelemetry": true,
  "enableDirectory": true,
  "sources": []
}

Next steps

After creating a registry:

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

See also

On this page