Skip to Content
CLI (lol)Command Reference

Command Overview

CommandDescription
lol runInject env vars and execute a command
lol listList secret names for the current directory
lol statusShow workspace mapping and vault state
lol doctorRun diagnostic checks
lol pingCheck if localWiki is reachable
lol helpShow usage information
lol --versionPrint the CLI version

Global Flags

FlagDescription
--jsonMachine-readable JSON output (works with all commands)

You can also set output_format = "json" in ~/.localwiki/lol.toml to default to JSON output.

lol run

Run a command with project keys injected as environment variables:

$ lol run -- npm run dev $ lol run --env staging -- python manage.py migrate $ lol run --env production -- docker compose up

The -- separator is required before the target command. Everything after -- is passed through as-is.

Options

FlagDescription
--env <environment>Target environment (default: development)
--workspace <name>Override directory mapping with a workspace name
--dir <path>Override working directory for mapping

lol run resolves the key store by matching your current working directory (or --dir) to a configured directory mapping. See Piping to Projects for setup.

If there are unresolved conflicts on any keys, lol run will fail with an error. Use lol doctor to diagnose, and resolve conflicts in the desktop app.

lol list

List secret names available for the current directory’s mapped workspace:

$ lol list $ lol list --json

lol status

Show the current directory mapping, workspace, secret count, and vault lock state:

$ lol status $ lol status --json

lol doctor

Run a series of diagnostic checks and report the results:

$ lol doctor $ lol doctor --json

Doctor runs the following checks:

  1. App reachable — can the CLI connect to the localWiki desktop app?
  2. Vault unlocked — is the vault currently unlocked?
  3. Directory mapped — does the current directory map to a workspace?
  4. Secrets available — are there secrets configured for this workspace?
  5. No conflicts — would injection succeed without conflict errors?

lol ping

Check whether the localWiki desktop app is running and reachable:

$ lol ping $ lol ping --json

Returns the app version on success.

lol help

Print usage information:

$ lol help $ lol --help $ lol -h

lol --version

Print the CLI version:

$ lol --version $ lol -V

Configuration File

You can set defaults in ~/.localwiki/lol.toml:

# Default environment for lol run default_environment = "development" # Default workspace override default_workspace = "my-team" # Output format: "text" or "json" output_format = "text"

CLI flags always override config file values.

Last updated on