registry make

Last updated on

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

Usage

asterdoc registry make [directory] [options]

Arguments

Options

Description

Creates registry.config.json, the file you list your artifact files in. This is the first step in hosting your own Asterdoc 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:

asterdoc registry make

Create in a specific directory with options:

asterdoc 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: asterdoc registry catalog add <artifact>
  2. Compile registry with: asterdoc 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 asterdoc registry catalog add <artifact>
2. Compile the registry with asterdoc registry compile
3. Deploy the compiled output to your hosting provider

See also

• registry catalog - Manage catalog items
• registry compile - Compile registry artifacts
• Creating registries - Full registry hosting guide