Skip to main content
The Rhetoric CLI allows you to invoke API operations from the command line, so you can create filers, start filing sessions, and inspect results from a terminal without writing any code. It is useful for exploring the API, scripting one-off tasks, and debugging an integration. This reference describes how to install and configure the CLI, and documents each command.

​
Installation

Run the appropriate command below to install the rhetoric binary to ~/.rhetoric/bin. Add that directory to your PATH to complete installation, or move it to a directory that is on your path.
Prebuilt binaries are currently available for macOS (Apple Silicon), Linux (x86_64), and Windows (x86_64).

​
Configure

Every command requires a server URL and an API key. Create a key from the dashboard. Like any API key, it is scoped to an environment (live or test), so use a test key while you are getting familiar with the CLI. You can provide these on every invocation with --url and --token:
or set them once via environment variables:
or in a config file at ~/.rhetoric/config.toml:
Values are resolved in this order of priority:
  • Command line flags
  • Environment variables
  • Config file

​
Output

Every command prints its result as JSON to standard out. Run rhetoric --help or rhetoric <command> --help for the full list of flags for any command.