Skip to main content
The CLI is an internal agent interface shipped with Almanac. Managed agents receive both the CLI and their runtime identity automatically; follow managed-agent guidance without a new login flow.

Development checkout

The CLI requires Python 3.12 or later. From an authorized product checkout:
Use that same prefix in place of almanac for the examples below. For isolated packaging checks, build a wheel with uv build --project cli and install the resulting local artifact. Runtime and Desktop releases carry their matching CLI; there is no separate public installation or self-update step.

Connect the personal identity

Replace the example endpoint with the authorized compatible backend. Login opens browser authentication and saves local credentials. whoami checks that identity remotely. almanac setup combines guidance installation with login when needed; agent setup explains what it installs. almanac logout clears stored login. It does not disconnect provider accounts or remove an environment-supplied token. Provider accounts have their own connection lifecycle.

Selecting credentials

Outside managed execution, the root --user option explicitly selects stored user login. Otherwise the CLI selects an explicit --token, then ALMANAC_TOKEN_FILE, then ALMANAC_TOKEN, then stored login. It does not fall through to another identity when a selected token file is invalid. Keep credentials out of command transcripts and documentation examples. An API credential is not a Gmail account ID: use accounts list for the latter.

Diagnosing setup

Doctor checks local configuration and guidance. It does not prove remote credentials or every provider are working. A successful whoami establishes the personal API identity, not Gmail access or Netrows availability. If a documented command is missing, compare --version and installed --help before changing credentials or retrying against another backend.