OpenForm
CLICommands

search

Last updated on

Search for artifacts in registries

Searches for artifacts in a registry.

Usage

ofm search [query] [options]

Arguments

ArgumentDescription
querySearch query (matches name, title, or description)

Options

OptionDescription
--registry <namespace>Registry namespace to search (default: @open-form)
--kind <kind>Filter by artifact kind: form, document, checklist, bundle
--tags <tags>Filter by tags (comma-separated)
--jsonOutput as JSON

Description

The search command queries a registry's index to find matching artifacts. You can filter results by kind, tags, or a text query that matches against artifact names, titles, and descriptions.

Examples

Search all artifacts:

ofm search

Search with a query:

ofm search "lease agreement"

Filter by kind:

ofm search --kind form

Filter by tags:

ofm search --tags legal,real-estate

Search a specific registry:

ofm search --registry @acme "tax"

Output as JSON:

ofm search --json

Output

Found 3 artifacts:

@acme/residential-lease v1.0.0
  Residential Lease Agreement
  Standard residential lease agreement for property rentals
  form · #legal #real-estate · 2 layers

@acme/commercial-lease v1.0.0
  Commercial Lease Agreement
  Commercial property lease agreement
  form · #legal #commercial · 2 layers

@acme/lease-addendum v1.0.0
  Lease Addendum
  form · #legal · 1 layer

Run 'ofm add @acme/<name>' to install an artifact.

See also

  • add - Install an artifact
  • registry - Manage registry configurations

On this page