Skip to content

fm secrets

Reference for the fm secrets command group (auto-generated from fm secrets --help).

fm secrets

text
Manage secrets stored in the Frostmoln secrets manager.

Usage:
  fm secrets [command]

Aliases:
  secrets, secret

Available Commands:
  create      Create a secret
  delete      Delete a secret
  get         Get secret details
  get-version Get a specific secret version
  list        List secrets
  recover     Recover a deleted secret
  update      Update a secret
  versions    List secret versions

Flags:
  -h, --help   help for secrets

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

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

fm secrets create

text
Create a new secret.

Examples:
  fm secrets create --name my-secret --value "s3cr3t"
  fm secrets create --name db-password --value "pass123" --content-type text/plain --description "Database password"
  fm secrets create --name api-creds --value '{"key":"val"}' --content-type application/json --tags env=prod,team=backend

Usage:
  fm secrets create [flags]

Flags:
      --content-type string   content type (e.g., text/plain, application/json)
      --description string    secret description
  -h, --help                  help for create
      --max-versions int      maximum number of versions to retain
      --name string           secret name (required)
      --recovery-window int   recovery window in days after deletion
      --tags strings          tags in key=value format (comma-separated)
      --value string          secret value (required)

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm secrets delete

text
Soft-delete a secret. It can be recovered within the recovery window.

Usage:
  fm secrets delete <id> [flags]

Flags:
      --force   skip confirmation prompt
  -h, --help    help for delete

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm secrets get

text
Get detailed information about a specific secret, including its value.

Usage:
  fm secrets get <id> [flags]

Flags:
  -h, --help         help for get
      --show-value   reveal the secret value (masked by default)

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm secrets get-version

text
Get the value a secret had at a specific version.

Usage:
  fm secrets get-version <id> <version> [flags]

Flags:
  -h, --help         help for get-version
      --show-value   reveal the secret value (masked by default)

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm secrets list

text
List all secrets for the current tenant.

Usage:
  fm secrets list [flags]

Flags:
  -h, --help   help for list

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm secrets recover

text
Recover a soft-deleted secret that is still within its recovery window.

Usage:
  fm secrets recover <id> [flags]

Flags:
  -h, --help   help for recover

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm secrets update

text
Update an existing secret's value, description, or tags.

Examples:
  fm secrets update <id> --value "new-value"
  fm secrets update <id> --description "Updated description"
  fm secrets update <id> --tags env=staging,team=platform

Usage:
  fm secrets update <id> [flags]

Flags:
      --description string   new description
  -h, --help                 help for update
      --tags strings         new tags in key=value format (comma-separated)
      --value string         new secret value

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm secrets versions

text
List the version history of a secret.

Usage:
  fm secrets versions <id> [flags]

Flags:
  -h, --help   help for versions

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)