OpenForm
CLICommands

list

Last updated on

List installed artifacts

Lists all artifacts installed in the current project.

Usage

ofm list [options]
ofm ls [options]

Options

OptionDescription
--jsonOutput as JSON
--kind <kind>Filter by artifact kind: form, document, checklist, bundle

Description

The list command reads the project's lock file and displays all installed artifacts, grouped by namespace. It shows the artifact name, version, and number of downloaded layers.

Examples

List all installed artifacts:

ofm list

Using the alias:

ofm ls

Output as JSON:

ofm list --json

Output

Installed artifacts (3):

@acme
  residential-lease v1.0.0 (2 layers)
  w9 v1.0.0 (1 layer)

@internal
  employee-onboarding v2.1.0

When no artifacts are installed:

No artifacts installed.
Run 'ofm add @namespace/artifact-name' to install one.

JSON output

[
  {
    "ref": "@acme/residential-lease",
    "version": "1.0.0",
    "format": "yaml",
    "path": "artifacts/@acme/residential-lease.yaml",
    "installedAt": "2025-01-15T10:30:00.000Z",
    "layers": ["pdf", "markdown"]
  }
]

See also

  • add - Install an artifact
  • show - View artifact details

On this page