CLI Overview
The lim CLI lets you manage your entire accounting workflow from the terminal. Natural language input, financial reports, bank reconciliation, and AI agent integration — all without opening a browser.
Installation
Verify the installation:
For staging validation, use the private beta package instead:
Authentication
lim uses OAuth via WorkOS. Run:
This opens your default browser for authentication. Once you authorize, the CLI stores a token locally.
To log out:
Tokens are stored in ~/.config/lim/credentials.json. The CLI automatically refreshes expired
tokens.
Configuration
The CLI reads configuration from three sources, in order of precedence:
- Command-line flags — highest priority
- Environment variables — prefixed with
LIM_
- Config file —
~/.config/lim/config.json
Setting the Active Company
Most commands require a company context. Set it once:
This writes the active company ID to your config file so you don’t need to pass --company every time.
All commands support three output formats:
Command Groups
Global Flags
Shell Completions
Generate shell completions for your shell:
Staging validation checklist
For the private beta package, the fastest end-to-end validation flow is:
