Skip to main content

Loom CLI command reference

This page is generated from deterministic --help output captured from the built loom executable. Do not edit it by hand.

$ loom --help
loom (Stage 0 scaffold)

Usage:
loom [flags]
loom [command]

Available Commands:
check Validate a Loom or GitLab workflow and emit a receipt
compile Compile a Loom workflow or produce a GitLab plan report
completion Generate the autocompletion script for the specified shell
config Inspect layered runtime config
help Help about any command
run Execute a Loom or GitLab workflow locally
secrets Manage Loom secrets providers
version Print the version

Flags:
-h, --help help for loom

Use "loom [command] --help" for more information about a command.

$ loom check --help
Validate a Loom or GitLab workflow and emit a receipt

Usage:
loom check [flags]

Flags:
--context string Project-relative GitLab pipeline context JSON path
--format string Workflow source format: loom or gitlab
-h, --help help for check
--workflow string Project-relative workflow path

$ loom compile --help
Compile a Loom workflow or produce a GitLab plan report

Usage:
loom compile [flags]

Flags:
--context string Project-relative GitLab pipeline context JSON path
--format string Workflow source format: loom or gitlab
-h, --help help for compile
--workflow string Project-relative workflow path

$ loom config --help
Inspect layered runtime config

Usage:
loom config [command]

Available Commands:
init Create a starter runtime config file
show Print the effective layered runtime config

Flags:
-h, --help help for config

Use "loom config [command] --help" for more information about a command.

$ loom config init --help
Create a starter runtime config file

Usage:
loom config init [flags]

Flags:
-h, --help help for init
--user Create ~/.config/loom/config.yml instead of the repo-scoped .loom/config.yml

$ loom config show --help
Print the effective layered runtime config

Usage:
loom config show [flags]

Flags:
-h, --help help for show

$ loom run --help
Execute a Loom or GitLab workflow locally

Usage:
loom run [flags]

Flags:
--cache-diff Run twice with pinned inputs (cache=off, then cache=on) and quarantine cache-hit keys on mechanical divergence
--context string Project-relative GitLab pipeline context JSON path
--docker-workspace-mount string Docker workspace mount mode override: bind_mount or ephemeral_volume
--format string Workflow source format: loom or gitlab
-h, --help help for run
--local Run locally (required for now). Nodes with an image use Docker; otherwise run on the host shell
--parallel int Maximum number of jobs to run concurrently (must be positive)
--privileged-service stringArray Allow one GitLab privileged service alias (repeatable)
-q, --quiet Print only minimal local execution output
--stream Stream job stdout/stderr while local execution is running
-v, --verbose Print additional metadata for local execution
--workflow string Project-relative workflow path

$ loom version --help
Print the version

Usage:
loom version [flags]

Flags:
-h, --help help for version

$ loom secrets --help
Manage Loom secrets providers

Usage:
loom secrets [command]

Available Commands:
keepass Manage KeePass-backed vaults and items
op Manage 1Password-backed vault metadata and items

Flags:
-h, --help help for secrets

Use "loom secrets [command] --help" for more information about a command.

$ loom secrets keepass --help
Manage KeePass vault and item metadata via create/update/list operations. Secret-value read/show commands are intentionally not available.

Usage:
loom secrets keepass [command]

Available Commands:
item Manage KeePass item metadata
vault Manage KeePass vault definitions

Flags:
-h, --help help for keepass

Use "loom secrets keepass [command] --help" for more information about a command.

$ loom secrets keepass vault --help
Manage KeePass vault definitions

Usage:
loom secrets keepass vault [command]

Available Commands:
create Create a KeePass vault definition
list List KeePass vaults without exposing secret values
update Update KeePass vault credentials for an existing mapped vault

Flags:
-h, --help help for vault

Use "loom secrets keepass vault [command] --help" for more information about a command.

$ loom secrets keepass vault create --help
Create a local KeePass `.kdbx` vault file. Credentials are provided via `--password-from-env` and/or `--keyfile-from-env`. This command never prints credential values.

Usage:
loom secrets keepass vault create [flags]

Flags:
--database-path .kdbx Path to write the KeePass .kdbx file (default: .loom/keepass/<alias>.kdbx)
--force Overwrite existing vault file if it already exists
-h, --help help for create
--keyfile-from-env string Environment variable name containing the KeePass keyfile path
--password-from-env string Environment variable name containing the KeePass master password
--vault-path string Vault path override (defaults to Git origin path in slash format, e.g. group/project/repo)

$ loom secrets keepass vault update --help
Rotate credentials on an existing KeePass vault file using the runtime mapping for `--vault-path`.
Current credentials are loaded from `LOOM_KEEPASS_DB_<ALIAS>_*` env mapping; new credentials come from `--password-from-env` and/or `--keyfile-from-env`.
This command only updates vault credentials and does not print secret values.

Usage:
loom secrets keepass vault update [flags]

Flags:
-h, --help help for update
--keyfile-from-env string Environment variable name containing the new KeePass keyfile path
--password-from-env string Environment variable name containing the new KeePass master password
--vault-path string Vault path override (defaults to Git origin path in slash format, e.g. group/project/repo)

$ loom secrets keepass vault list --help
List KeePass vaults without exposing secret values

Usage:
loom secrets keepass vault list [flags]

Flags:
-h, --help help for list
--vault-path string Vault path override (defaults to Git origin path in slash format, e.g. group/project/repo)

$ loom secrets keepass item --help
Manage KeePass item metadata

Usage:
loom secrets keepass item [command]

Available Commands:
create Create a KeePass item field from an environment variable
list List KeePass items without exposing secret values
update Update a KeePass item field from an environment variable

Flags:
-h, --help help for item

Use "loom secrets keepass item [command] --help" for more information about a command.

$ loom secrets keepass item create --help
Create a KeePass item field from an environment variable

Usage:
loom secrets keepass item create [flags]

Flags:
--field string Item field name to set (for example username or password)
-h, --help help for create
--item-path string Vault item path to create/update
--value-from-env string Name of environment variable that supplies the field value
--vault-path string Vault path override (defaults to Git origin path in slash format, e.g. group/project/repo)

$ loom secrets keepass item update --help
Update a KeePass item field from an environment variable

Usage:
loom secrets keepass item update [flags]

Flags:
--field string Item field name to set (for example username or password)
-h, --help help for update
--item-path string Vault item path to create/update
--value-from-env string Name of environment variable that supplies the field value
--vault-path string Vault path override (defaults to Git origin path in slash format, e.g. group/project/repo)

$ loom secrets keepass item list --help
List KeePass items without exposing secret values

Usage:
loom secrets keepass item list [flags]

Flags:
-h, --help help for list
--item-prefix string Optional item path prefix filter
--vault-path string Vault path override (defaults to Git origin path in slash format, e.g. group/project/repo)

$ loom secrets op --help
Manage 1Password vault and item metadata via list/create/update operations.
These commands require OP_SERVICE_ACCOUNT_TOKEN and intentionally never print secret values.

Usage:
loom secrets op [command]

Available Commands:
item Manage 1Password item metadata
vault List 1Password vaults

Flags:
-h, --help help for op

Use "loom secrets op [command] --help" for more information about a command.

$ loom secrets op vault --help
List 1Password vaults

Usage:
loom secrets op vault [command]

Available Commands:
list List 1Password vaults without exposing secret values

Flags:
-h, --help help for vault

Use "loom secrets op vault [command] --help" for more information about a command.

$ loom secrets op vault list --help
List 1Password vaults without exposing secret values

Usage:
loom secrets op vault list [flags]

Flags:
-h, --help help for list

$ loom secrets op item --help
Manage 1Password item metadata

Usage:
loom secrets op item [command]

Available Commands:
create Create a 1Password item field from an environment variable
list List 1Password items without exposing secret values
update Update a 1Password item field from an environment variable

Flags:
-h, --help help for item

Use "loom secrets op item [command] --help" for more information about a command.

$ loom secrets op item create --help
Create a 1Password item field from an environment variable

Usage:
loom secrets op item create [flags]

Flags:
--field string Item field name to set (for example username or password)
-h, --help help for create
--item-path string Item path/title to create or update
--value-from-env string Name of environment variable that supplies the field value
--vault string 1Password vault name or UUID

$ loom secrets op item update --help
Update a 1Password item field from an environment variable

Usage:
loom secrets op item update [flags]

Flags:
--field string Item field name to set (for example username or password)
-h, --help help for update
--item-path string Item path/title to create or update
--value-from-env string Name of environment variable that supplies the field value
--vault string 1Password vault name or UUID

$ loom secrets op item list --help
List 1Password items without exposing secret values

Usage:
loom secrets op item list [flags]

Flags:
-h, --help help for list
--item-prefix string Optional item path prefix filter
--vault string 1Password vault name or UUID