Skip to content

CLI Reference

Complete command-line interface reference for lbx.

Overview

lbx provides a command-line interface with consistent patterns and helpful error messages.

Installation

pipx install lbx

See Installation Guide for other installation options.

Global Options

These options are available for all commands:

Option Description
--help Show help message and exit
--version Show version information
-v --vault Path to the vault file. Defaults to ~/.lbx/vault.lbx

Command Reference

The following sections document all available commands. Commands are auto-generated from the CLI implementation.

lbx

Usage: lbx [OPTIONS] COMMAND [ARGS]...

  Lbx encrypted secret manager.

Options:
  --version         Show the version and exit.
  -v, --vault PATH  Path to the vault file. Defaults to ~/.lbx/vault.lbx
  --help            Show this message and exit.

Commands:
  secret   Secret operations.
  service  Service operations.
  vault    Vault management commands.

lbx secret

Usage: lbx secret [OPTIONS] COMMAND [ARGS]...

  Secret operations.

Options:
  --help  Show this message and exit.

Commands:
  add     Add a new secret.
  delete  Delete a secret.
  get     Get decrypted secret.
  list    List secrets.
  move    Move a secret to another service.
  rename  Rename a secret.
  update  Update an existing secret.

lbx secret add

Usage: lbx secret add [OPTIONS] SERVICE NAME

  Add a new secret.

Options:
  --value TEXT  Secret value; if omitted, read from stdin or prompt.
  --help        Show this message and exit.

lbx secret delete

Usage: lbx secret delete [OPTIONS] SERVICE NAME

  Delete a secret.

Options:
  --help  Show this message and exit.

lbx secret get

Usage: lbx secret get [OPTIONS] SERVICE NAME

  Get decrypted secret.

Options:
  --help  Show this message and exit.

lbx secret list

Usage: lbx secret list [OPTIONS]

  List secrets.

Options:
  -s, --service TEXT  Filter by service
  --help              Show this message and exit.

lbx secret move

Usage: lbx secret move [OPTIONS] SOURCE NAME TARGET

  Move a secret to another service.

Options:
  --help  Show this message and exit.

lbx secret rename

Usage: lbx secret rename [OPTIONS] SERVICE OLD NEW

  Rename a secret.

Options:
  --help  Show this message and exit.

lbx secret update

Usage: lbx secret update [OPTIONS] SERVICE NAME

  Update an existing secret.

Options:
  --value TEXT  New value; if omitted, read from stdin or prompt.
  --help        Show this message and exit.

lbx service

Usage: lbx service [OPTIONS] COMMAND [ARGS]...

  Service operations.

Options:
  --help  Show this message and exit.

Commands:
  delete  Delete a service.
  list    List all services.
  rename  Rename a service.

lbx service delete

Usage: lbx service delete [OPTIONS] NAME

  Delete a service.

Options:
  --help  Show this message and exit.

lbx service list

Usage: lbx service list [OPTIONS]

  List all services.

Options:
  --help  Show this message and exit.

lbx service rename

Usage: lbx service rename [OPTIONS] OLD NEW

  Rename a service.

Options:
  --help  Show this message and exit.

lbx vault

Usage: lbx vault [OPTIONS] COMMAND [ARGS]...

  Vault management commands.

Options:
  --help  Show this message and exit.

Commands:
  delete  Delete vault file and keychain entry.
  init    Create a new vault.
  lock    Lock vault (clear key from memory).
  status  Show vault status.
  unlock  Unlock vault using a password.

lbx vault delete

Usage: lbx vault delete [OPTIONS]

  Delete vault file and keychain entry.

Options:
  --help  Show this message and exit.

lbx vault init

Usage: lbx vault init [OPTIONS]

  Create a new vault.

Options:
  --help  Show this message and exit.

lbx vault lock

Usage: lbx vault lock [OPTIONS]

  Lock vault (clear key from memory).

Options:
  --help  Show this message and exit.

lbx vault status

Usage: lbx vault status [OPTIONS]

  Show vault status.

Options:
  --help  Show this message and exit.

lbx vault unlock

Usage: lbx vault unlock [OPTIONS]

  Unlock vault using a password.

Options:
  --help  Show this message and exit.

Exit Codes

Code Meaning
0 Success
1 Failure

See Also

Getting Started:

Reference:

Contributing: