Getting Started¶
Requirements¶
- macOS (arm64 or amd64)
- Go 1.25+ (only if building from source)
Installation¶
Homebrew (recommended)¶
From source¶
From GitHub Releases¶
Download the latest binary from GitHub Releases and place it in your $PATH.
Initialize a vault¶
This does three things:
- Creates
~/.maestrovault/directory - Generates a 256-bit master key
- Stores the master key in the macOS Keychain
Note
You only need to run init once. The vault persists across terminal sessions.
Store your first secret¶
You can also add metadata for organization and specify an environment:
mav set db-password \
--value "p@ssw0rd" \
--env production \
--metadata service=postgres \
--metadata team=backend
If you omit --value, MaestroVault reads from stdin (useful for piping):
To store a file byte-for-byte (PEM certificates, SSH keys, etc.):
Retrieve a secret¶
Output format auto-detects: table for terminals, JSON when piped:
List secrets¶
Filter by metadata:
Filter by environment:
Search¶
Searches secret names, environments, and metadata in real time.
Copy to clipboard¶
The clipboard is automatically cleared after 45 seconds. Override with --clear:
Generate a password¶
# Generate and print
mav generate
# Generate and store
mav generate --name wifi-password --length 24
# Customize character sets
mav generate --no-symbols --length 16
Use secrets as environment variables¶
# Print export statements
mav env
# Run a command with secrets injected
mav exec -- env | grep MY_SECRET
Export and import¶
# Export to JSON
mav export > backup.json
# Export to .env format
mav export --format env > .env
# Import from JSON
mav import backup.json
# Import from .env
mav import --format env .env
Warning
Export files contain plaintext secrets. Handle with care and delete after use.
Enable TouchID¶
Once enabled, every command that accesses the vault will prompt for biometric authentication.
mav touchid status # Check current state
mav touchid disable # Turn it off (requires TouchID to disable)
Launch the TUI¶
For vim keybindings:
Configuration¶
MaestroVault stores settings in ~/.maestrovault/config.json:
| Field | Description |
|---|---|
touchid |
Enable TouchID biometric gate on vault open |
vim_mode |
Enable vim keybinding modes in the TUI |
fuzzy_search |
Enable fuzzy matching in TUI search |
All settings can also be toggled from the TUI settings overlay (S).
What's next¶
- CLI Reference -- all commands and flags
- TUI Guide -- keyboard shortcuts and features
- REST API -- run the API server
- Security -- encryption details and threat model