Setup and auth

Generated from --help output of fob-actual 0.1.0. Every command also accepts the global options --profile <name>, --help and --version.

config budgets is an alias of config profiles; the two are interchangeable.

config profiles#

config profiles list#

fob-actual config profiles list

List profiles (current marked with *)

Options:
      --json  Output raw JSON                                                              [boolean]

config profiles current#

fob-actual config profiles current

Show the active profile + resolution source

Options:
      --json  Output raw JSON                                                              [boolean]

config profiles add#

fob-actual config profiles add <name>

Add or update a profile's Actual credentials (upsert)

Positionals:
  name  Profile name                                                             [string] [required]

Options:
      --server-url           Actual sync server URL                                         [string]
      --session-token        Session token (see `fob-actual auth login`)                    [string]
      --sync-id              Budget sync id to bind this profile to                         [string]
      --encryption-password  Password for an end-to-end encrypted budget                    [string]
      --data-dir             Local budget cache directory (defaults to ~/.fob/fob-actual/data/<name>
                             )                                                              [string]

config profiles use#

fob-actual config profiles use <name>

Set the current profile

Positionals:
  name  Profile name                                                             [string] [required]

config profiles remove#

fob-actual config profiles remove <name>

Remove a profile (requires --yes)

Positionals:
  name  Profile name                                                             [string] [required]

Options:
  -y, --yes  Confirm removal                                                               [boolean]

config profiles refresh#

fob-actual config profiles refresh [name]

Re-sync a profile's cached budget metadata from the server

Positionals:
  name  Profile name                                                                        [string]

Options:
      --all  Refresh every configured profile                                              [boolean]

auth#

auth login#

fob-actual auth login

Store a session token for the current profile

Options:
      --server-url     Actual sync server URL                                               [string]
      --session-token  Token to store (skips the interactive prompt)                        [string]
      --password       Sign in with a server password (password-auth servers only)          [string]

auth status#

fob-actual auth status

Validate the stored token and show the bound budget

Options:
      --json  Output raw JSON                                                              [boolean]

auth logout#

fob-actual auth logout

Forget the stored session token

server#

server info#

fob-actual server info

Show the server URL and version

Options:
      --json  Output raw JSON                                                              [boolean]