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 install -g @lim-labs/lim
lim --version
# => lim/0.1.0
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...)
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
| Environment Variable | Flag | Description |
|---|
LIM_API_URL | --api-url | API base URL (default: https://api.uselim.com) |
LIM_COMPANY_ID | --company | Active company ID |
LIM_FORMAT | --format | Output format: table, json, csv |
Setting the Active Company
Most commands require a company context. Set it once:
lim companies use <company-id>
--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
| Command | Description |
|---|
lim add | Natural language journal entry |
lim journals | List, show, create, reverse journal entries |
lim reports | Financial reports (TB, P&L, BS, CF, etc.) |
lim companies | Company management |
lim accounts | Chart of accounts |
lim stats | Learning engine metrics and dashboard |
lim auth | Authentication (login, logout, whoami) |
lim import | Import from freee, MF, Yayoi, Bugyo, QuickBooks, Xero |
lim mcp | MCP server management |
lim skills | Claude Code skills registration |
Global Flags
| Flag | Description |
|---|
--help, -h | Show help for any command |
--version, -V | Show CLI version |
--company <id> | Override active company |
--format <fmt> | Output format: table, json, csv |
--verbose | Show debug output |
--no-color | Disable 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
