Faustine CLI

The Faustine CLI is a command-line client for your gateways. It signs in with a gateway user or an API key, lists the operations the credential can use and calls them as shell commands. It is the npm package @faustine-ai/cli and installs the faustine command.

faustine login <workspace>/<gateway>
faustine ops
faustine call nimbuscrm.contacts.list --limit 2

Operation keys such as nimbuscrm.contacts.list are examples from a Nimbus CRM gateway. Yours come from faustine ops.

How it works

The CLI talks to the gateway over HTTP. It reads the gateway's OpenAPI document to learn the operations, their inputs and their outputs, and it calls an operation by sending a request to the gateway's REST interface with your credential. See Gateway HTTP.

Every call goes through the gateway like a call from any other client. The gateway applies the scope, limits and confirmation settings of the credential and records the call in its logs.

Sign in

The CLI accepts the two kinds of gateway credential.

For the steps of both, see Install the CLI and sign in.

Saved gateways

faustine login saves the gateway and its credential under an alias in ~/.config/faustine/credentials.json, a file only your user can read, and makes it the current gateway. The alias is the gateway's slug unless you pass --alias.

You can save several gateways. faustine gateways lists them, faustine use <alias> changes the current one and faustine logout removes one.

Each command chooses its gateway in this order:

1. The --gateway option, with a URL or an alias.
2. The FAUSTINE_GATEWAY environment variable, with a URL or an alias.
3. The current gateway.

When --api-key or FAUSTINE_API_KEY is set, the CLI uses that key instead of the saved credential.

Find and call operations

faustine ops lists the operations with their key, whether they read or write, and a summary. faustine help <operation> prints one operation's input options, output fields and an example command. faustine call <operation> runs it, with the operation's input fields as options.

See Call an operation from the CLI.

Output for people and for programs

On a terminal the CLI prints tables and colored JSON. When its output goes to a pipe or a file, it prints plain JSON, and errors are a JSON object on standard error with a stable code. The exit code says what kind of failure it was. The CLI does not ask questions when its input is not a terminal.

This is what lets a coding agent use a gateway through its shell with no other setup. See Use the CLI from a coding agent.

Next steps

• Install the CLI and sign in: install the package and make your first call.
• Call an operation from the CLI: pass inputs, choose a connection and read errors.
• Use the CLI from a coding agent: give Claude Code or a CI job access to a gateway.
• faustine CLI: every command, option, environment variable and exit code.
• @faustine-ai/cli: the package and its versions.