Documentation Index Fetch the complete documentation index at: https://docs.uselim.com/llms.txt
Use this file to discover all available pages before exploring further.
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 npm
pnpm
npx (no install)
private beta
npm install -g @lim-labs/lim
Verify the installation:
lim --version # => lim/0.1.0
For staging validation, use the private beta package instead:
lim-beta --version lim-beta env lim-beta auth login
Authentication lim uses OAuth via WorkOS. Run:
This opens your default browser for authentication. Once you authorize, the CLI stores a token locally.
lim auth whoami # => ✅ tsumi@uselim.com (user_01ABC...)
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 priorityEnvironment variables — prefixed with LIM_Config file — ~/.config/lim/config.json
Environment Variable Flag Description LIM_API_URL--api-urlAPI base URL (default: https://api.uselim.com) LIM_COMPANY_ID--companyActive company ID LIM_FORMAT--formatOutput format: table, json, csv
Setting the Active Company Most commands require a company context. Set it once:
lim companies use my-startup-inc
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:
# Human-readable table (default) lim reports tb --from 2026-01-01 --to 2026-12-31 # JSON for piping to other tools lim reports tb --from 2026-01-01 --to 2026-12-31 --format json # CSV for spreadsheets lim reports tb --from 2026-01-01 --to 2026-12-31 --format csv
Command Groups Group Commands Reference Access & config auth, doctor, env/cli/auth-and-diagnostics Core bookkeeping add, journals, reports, companies, accounts, dashboard, stats/cli/add , /cli/journals , /cli/reports , /cli/companies , /cli/accounts , /cli/dashboard , /cli/stats Cash conversion invoices, payments, bank, docs/cli/invoices-and-payments , /cli/banking , /cli/documents Migration & filing import, export/cli/import-and-export People ops employees, worker-contracts, payroll, expenses, approvals, members, withholding/cli/people-and-payroll Dispatch & labor alerts dispatch, workers/cli/dispatch-and-workers Close & compliance close, reopen, fx, labels, tax-codes, events/cli/periods-and-compliance Planning & automation contracts, assets, scenarios, accruals/cli/planning-and-automation
Global Flags Flag Description --help, -hShow help for any command --version, -VShow CLI version --company <id>Override active company --format <fmt>Output format: table, json, csv --verboseShow debug output --no-colorDisable colored output
Shell Completions Generate shell completions for your shell:
# Bash lim completion bash >> ~/.bashrc # Zsh lim completion zsh >> ~/.zshrc # Fish lim completion fish > ~/.config/fish/completions/lim.fish
Staging validation checklist For the private beta package, the fastest end-to-end validation flow is:
lim-beta doctor lim-beta auth login lim-beta companies list lim-beta companies use < company-i d > lim-beta accounts list lim-beta reports tb --from 2026-01-01 --to 2026-12-31
