Skip to content

Quick Start

1. Launch

omo

On first run, omo:

  1. Generates ~/.omo/keys/omo.key
  2. Creates ~/.omo/secrets/omo.kdbx (unlocked by that key file)

Back up the key file

Without ~/.omo/keys/omo.key you cannot open the secrets database.

2. Install plugins

Inside omo:

  1. Focus the plugins list (left sidebar) and press P
    — or Tab to the host actions list and select Package Manager
  2. Press ++S++ to sync the plugin index
  3. Press ++A++ to install all plugins (or install selectively)
  4. Press ++Q++ to return

Package Manager

Sync the index, install, and update plugins without leaving the TUI.

3. Add a connection

Every connection is a KeePass entry:

<plugin>/<environment>/<instance>

Examples: redis/production/cache-01, docker/development/local, k8sportforward/development/playground.

omo secrets put redis/development/local \
  --url localhost \
  --password mypass \
  --attr port=6379 \
  --attr database=0

omo secrets list redis
omo secrets get  redis/development/local
  1. Open ~/.omo/secrets/omo.kdbx
  2. Authenticate with Key File~/.omo/keys/omo.key
  3. Create groups redisdevelopment, entry local
  4. Set URL / username / password and custom attributes (port, …)

4. Operate

  1. Select the plugin in the sidebar
  2. Use Ctrl+T to pick the target
  3. Press ++?++ for plugin help
  4. Press ++R++ to refresh

Docker plugin

Containers, images, networks, volumes, and compose — keyboard-first.

Next