First Run & Vault¶
omo stores credentials in a local KeePass database. Nothing is uploaded.
What first launch creates¶
| Path | Purpose |
|---|---|
~/.omo/keys/omo.key |
Master key file — treat like a private key |
~/.omo/secrets/omo.kdbx |
KeePass KDBX4 vault unlocked by that key |
Back up the key file
Without ~/.omo/keys/omo.key you cannot open the secrets database.
Reference schema templates are also seeded at <plugin>/default/default_config (Notes only — empty credentials).
Connection path convention¶
| Segment | Meaning | Examples |
|---|---|---|
plugin |
Official plugin id | redis, docker, argocd |
environment |
Your naming | development, staging, production |
instance |
Specific target | local, cache-01, playground |
Press Ctrl+T inside a plugin to list entries under that plugin prefix.
KeePass field mapping¶
| Field | Settings key(s) | Typical use |
|---|---|---|
| Title | name |
Instance display name |
| URL | url + host |
Host / endpoint / socket / region (awsCosts) |
| UserName | username |
Username |
| Password | password |
Password / token / secret key |
| Notes | notes |
Free-form description |
| Custom attributes | as-is | port, database, sslmode, kubeconfig, … |
Full catalogs: KeePass schemas.
Example entries¶
Path: redis/production/cache-main
| Field | Value |
|---|---|
| URL | redis.example.com |
| Password | … |
port |
6379 |
database |
0 |
Path: postgres/production/app-db
| Field | Value |
|---|---|
| URL | db.example.com |
| UserName | admin |
| Password | … |
port |
5432 |
database |
myapp |
sslmode |
require |
Path: docker/development/local
| Field | Value |
|---|---|
| URL | unix:///var/run/docker.sock |
Path: k8sportforward/development/playground
| Field | Value |
|---|---|
kubeconfig |
~/.kube/config |
context |
kind-omo-playground (optional) |
namespace |
demo (optional) |
Path: ssh/production/web-01
| Field | Value |
|---|---|
| URL | 10.0.1.50 |
| UserName | deploy |
port |
22 |
auth_method |
key |
key_path |
~/.ssh/id_ed25519 |
Path: bunnydns/production/main
| Field | Value |
|---|---|
| Password | Bunny account AccessKey |
| URL | https://api.bunny.net (optional) |
Path: git/development/local
| Field | Value |
|---|---|
path |
/home/you/Work/my-repo |
| URL | remote URL (optional) |
Path: awsCosts/production/main
| Field | Value |
|---|---|
| URL | us-east-1 (region, not an HTTP URL) |
| UserName | access key ID |
| Password | secret access key |
Managing without a GUI¶
omo secrets list
omo secrets get redis/development/local
omo secrets put redis/development/local --url localhost --attr port=6379
omo secrets delete redis/development/local
See Secrets CLI.
Resetting the vault¶
Deletes omo.kdbx. The key file is kept. A new empty database (with reference templates) is created on next use.