CLI flags¶
./pluma --help is authoritative. This page mirrors it with extra notes.
Server flags¶
| Flag | Default | Env | Notes |
|---|---|---|---|
-addr <addr> |
:8787 |
PLUMA_ADDR |
Bind address. :8787 binds all interfaces; 127.0.0.1:8787 loopback only. |
-base-url <url> |
http://localhost:11434/v1 |
PLUMA_BASE_URL |
OpenAI-compatible upstream. Connection profiles override this once configured. |
-api-key <key> |
— | PLUMA_API_KEY |
Optional upstream API key. Persists into the active connection profile, then lives in the OS keyring. |
-data-dir <path> |
OS-native | PLUMA_DATA_DIR |
Data directory. macOS/Linux default ~/.config/pluma; Windows %AppData%\pluma. |
-card-dirs <paths> |
— | PLUMA_CARD_DIRS |
Comma-separated extra read-only Tavern card directories. Appends to card_dirs in config. |
-open |
true |
PLUMA_OPEN |
Open browser at the listen URL on startup. -open=false to skip. Overrides open_browser in config when explicitly passed. |
-version |
— | — | Print version and exit. Stamped at build time via -ldflags="-X main.version=<tag>"; local builds report dev. |
One-shot maintenance flags¶
These run, do their thing, and exit. The server never starts.
| Flag | Notes |
|---|---|
-export-storage-key <path> |
Passphrase-wrap the storage key and write to <path> for backup / cross-machine recovery. |
-import-storage-key <path> |
Unwrap a previously-exported key file into the local OS keyring. |
CLI subcommands¶
pluma <subcommand> hands off to cobra and never starts the server. Today's subcommands:
| Subcommand | Notes |
|---|---|
pluma auth login |
Mints a bearer token against a running Pluma server (uses your passkey). Stored at ~/.config/pluma/cli.token. |
pluma auth logout |
Removes the stored token. |
pluma auth whoami |
Prints the active token's identity. |
Bearer-token auth (-token or PLUMA_API_TOKEN) is the curl / script auth path, complementing WebAuthn passkeys for browser sessions.
Precedence¶
For any setting that exists in more than one place: CLI flag (when explicitly passed) → env var → config.toml → hardcoded default. See Reference index for the full rule.