Skip to content

CLI Quick Start

This guide shows you how to use the omnivault command-line tool for secure local secret management.

Installation

go install github.com/agentplexus/omnivault/cmd/omnivault@latest

Verify the installation:

omnivault version

Getting Started

1. Start the Daemon

The CLI requires a background daemon for secure operations:

omnivault daemon start

2. Initialize Your Vault

Create a new vault with a master password:

omnivault init

You'll be prompted to enter and confirm a master password (minimum 8 characters).

Remember Your Password

The master password is never stored. If you forget it, you cannot recover your secrets.

3. Store a Secret

# Prompted for value (hidden input)
omnivault set database/password

# Or provide value directly
omnivault set api/key sk-12345

4. Retrieve a Secret

omnivault get database/password

5. List Secrets

# List all secrets
omnivault list

# List secrets with a prefix
omnivault list database/

6. Delete a Secret

omnivault delete database/password

You'll be asked to confirm before deletion.

Session Management

Lock the Vault

Lock the vault to protect your secrets:

omnivault lock

Unlock the Vault

Unlock to access secrets again:

omnivault unlock

Check Status

View vault and daemon status:

omnivault status

Example output:

Daemon: running
Uptime: 2h30m15s
Vault: unlocked
Secrets: 5
Unlocked at: 2024-01-15 10:30:00

Auto-Lock

The vault automatically locks after 15 minutes of inactivity. Each secret operation resets the timer.

Daemon Management

# Start daemon in background
omnivault daemon start

# Stop the daemon
omnivault daemon stop

# Check daemon status
omnivault daemon status

# Run in foreground (for debugging)
omnivault daemon run

Typical Workflow

# First time setup
omnivault daemon start
omnivault init

# Daily usage
omnivault unlock
omnivault get my/secret
# ... work ...
omnivault lock

# Or let auto-lock handle it

Next Steps