Command Line Interface

CLI Documentation

Command-line tool for reconciliation operations

CLI Documentation Content

Installation

Install the Settler CLI tool

npm

npm install -g @settler/cli

yarn

yarn global add @settler/cli

pnpm

pnpm add -g @settler/cli

Authentication

Configure your API key

Set your API key as an environment variable or use the configure command:

export SETTLER_API_KEY=sk_...
# Or
settler configure

Commands

Available CLI commands

COMMAND

settler jobs

Manage reconciliation jobs

settler jobs list
settler jobs create <config-file>
settler jobs get <job-id>
settler jobs run <job-id>
COMMAND

settler reports

View reconciliation reports

settler reports get <job-id>
settler reports export <job-id> --format json
COMMAND

settler adapters

List available adapters

settler adapters list
COMMAND

settler webhooks

Manage webhook subscriptions

settler webhooks list
settler webhooks create <url>
settler webhooks delete <webhook-id>

💡 Pro Tip: For more detailed documentation, see our main documentation or explore the cookbooks for examples.

Ready to Get Started?

Start your 14-day free trial and get full access to all features. No credit card required.

No credit card required30-day free trialCancel anytime
Start Free TrialView Pricing