The FinOpsBricks CLI
Use dedicated clients for Statements, Transactions, Ledger and Orchestrator. Each module client also exposes a library for your scripts. The fob dispatcher routes commands to the tools you install.
# install the dispatcher and the tools you want
$ npm i -g @finopsbricks/fob-cli @finopsbricks/fob-stm
# inspect the command; configure a profile before querying data
$ fob stm accounts list --helpData commands require the relevant client’s credentials and organization profile. Follow the setup walkthrough →
Module clients and dispatcher
Published on npm. Install the fob dispatcher, then add the tools you need.
| Tool | Command | What it does |
|---|---|---|
fob @finopsbricks/fob-cli | fob <tool> … | Dispatcher for independently installed fob-* tools. |
fob-stm @finopsbricks/fob-stm | fob stm accounts list | Statements client: accounts, transactions, statement files, rules and reports. |
fob-txn @finopsbricks/fob-txn | fob txn transactions list | Read accounts and transactions extracted by the Transactions app. |
fob-lgr @finopsbricks/fob-lgr | fob lgr accounts tree | Shadow ledger client: accounts, balanced transactions and entries. |
fob-orc @finopsbricks/fob-orc | fob orc stations list | Orchestrator control plane: lines, stations, work records, tags and documents. |
fob-workerBeta @finopsbricks/fob-worker | fob worker steps run | Build Orchestrator workers: run and debug steps on your machine, see every workpiece in every bin, and run the worker under pm2. |
Integrations
Clients for systems you already use, such as your accounting software, your budget and your mailbox. They talk to that system directly with your own credentials.
| Tool | Command | What it does |
|---|---|---|
fob-actualBeta @finopsbricks/fob-actual | fob actual accounts list | Your Actual Budget from the terminal: transactions, the monthly budget, rules and ActualQL, with a dry run before every write. |
fob-emailBeta @finopsbricks/fob-email | fob email emails list | Your inbox from the terminal: search, download attachments, file and send over IMAP/SMTP, built for scripts and AI agents. |
fob-zbBeta @finopsbricks/fob-zb | fob zb invoices list | Zoho Books from the terminal: 27 resources, reads and writes, built for scripts and AI agents. |