Setup: config and auth

Generated from --help output of fob-zb 0.2.1. Every command also accepts the global options --profile <name> (alias --org), --help and --version.

getting-started#

fob-zb getting-started

Setup walkthrough: connect a Zoho Books organization

config profiles#

config profiles list#

fob-zb config profiles list

List profiles (current marked with *)

Options:
      --json  Output raw JSON                                          [boolean]

config profiles current#

fob-zb config profiles current

Show the active profile + resolution source

Options:
      --json  Output raw JSON                                          [boolean]

config profiles add#

fob-zb config profiles add <name>

Add or update a profile's Zoho Books OAuth credentials (upsert)

Positionals:
  name  Profile name                                         [string] [required]

Options:
      --region           Zoho data center
     [string] [choices: "com", "eu", "in", "com.au", "jp", "ca", "com.cn", "sa"]
      --client-id        OAuth client id                                [string]
      --client-secret    OAuth client secret                            [string]
      --grant-code       One-time self-client grant code (exchanged for a refres
                         h token)                                       [string]
      --refresh-token    An existing refresh token (alternative to --grant-code)
                                                                        [string]
      --organization-id  Zoho organization (tenant) id                  [string]
      --from             Reuse another profile's OAuth credentials (add a second
                          org without a new Self Client)                [string]
      --redirect-uri     Redirect URI (only for web auth-code grants, not self-c
                         lient)                                         [string]

config profiles use#

fob-zb config profiles use <name>

Set the current profile

Positionals:
  name  Profile name                                         [string] [required]

config profiles remove#

fob-zb config profiles remove <name>

Remove a profile

Positionals:
  name  Profile name                                         [string] [required]

config profiles refresh#

fob-zb config profiles refresh [name]

Refresh a profile's org identity from the server (--all for every profile)

Positionals:
  name  Profile name (omit with --all)                                  [string]

Options:
      --all  Refresh every profile                                     [boolean]

auth#

auth status#

fob-zb auth status

Show the active identity and access-token freshness

Options:
      --json  Output raw JSON                                          [boolean]

auth refresh#

fob-zb auth refresh

Force an access-token refresh now

Options:
      --json  Output raw JSON                                          [boolean]

auth logout#

fob-zb auth logout

Revoke the refresh token at Zoho and clear cached tokens locally

Options:
      --local  Clear locally only; do not revoke at Zoho               [boolean]