Docs

Your first account query.

Start with Statements. Install its command-line client, connect an organization, and read your accounts. The fob dispatcher gives the independently installed clients one command prefix.

Quickstart

You need Node.js and npm. To read data, you also need access to a Statements organization and an API key with account read permission.

1. Install the dispatcher and Statements client
$ npm i -g @finopsbricks/fob-cli @finopsbricks/fob-stm
The package @finopsbricks/fob-cli installs fob; @finopsbricks/fob-stm installs fob-stm. Other modules have separate clients and profiles.
2. Inspect the command
$ fob stm accounts list --help
First line of captured CLI help
```
Usage: fob-stm accounts list [options]
```
Help works without credentials. It lists filters, output formats and pagination options.
3. Connect your organization
Open Statements, choose your organization, then go to Settings → API keys. Create a key with account read permission and copy its key and secret. The CLI can print the setup walkthrough:
$ fob stm getting-started
Set the shell variables below to your own key and secret before running this command. They are placeholders for values you supply.
$ fob stm config profiles add myorg --api-key "$FOB_STM_API_KEY" --api-secret "$FOB_STM_API_SECRET"
4. Read your accounts
$ fob stm accounts list
This reads the active profile’s accounts. If the list is empty, add an account or upload a supported statement in the app, then query again. Installing the CLI does not populate your financial data.
List commands return one page by default. Use --all when needed (up to 15,000 rows). Check each client’s amount-unit contract before using JSON in calculations.