Fob
Browse the docs

Install the CLI

1. Install Node.js#

fob-zb needs Node.js 18 or later. Install the current LTS release from the official Node.js download page. It includes npm, the package installer used below.

Check both commands work in Terminal (macOS/Linux) or PowerShell (Windows):

node --version
npm --version

2. Install fob-zb#

npm install -g @finopsbricks/fob-zb
fob-zb --version

Then connect your organization:

fob-zb getting-started

It prints the setup steps, or tells you setup is already done. The same steps, with more detail, are in Connect Zoho Books.

Optional: the fob dispatcher#

If you use other FinOpsBricks CLIs, the fob dispatcher gives them one prefix. Any fob-* tool on your PATH becomes fob <tool>:

npm install -g @finopsbricks/fob-cli
fob zb invoices list          # same as: fob-zb invoices list

The docs use fob-zb. Both forms work everywhere.

Updating#

npm install -g @finopsbricks/fob-zb@latest

Your profiles in ~/.fob/fob-zb/config.yml are kept. See the changelog for what's new.

If the command is not found#

  • Reopen your terminal after installing, so it picks up the new PATH.
  • Check npm's global bin folder is on your PATH: npm prefix -g shows the install prefix, and the binaries are in its bin folder (on Windows, the prefix folder itself).
  • An npm EACCES permission error means your global install folder isn't writable. Use a Node.js installed for your user account (for example with a version manager such as nvm or fnm). Don't use sudo npm.