ApiCourier.CLI 0.6.0-insider

ApiCourier CLI

Run API requests, collections, flows and SQL queries from the terminal or CI, using the same execution pipeline as the ApiCourier desktop app.

ApiCourier is Git-native and local-first: your requests, collections and environments are plain YAML files in your repository. The CLI reads that same workspace, so anything you can run in the app you can run in a pipeline, with no export step and no account required.

Install

dotnet tool install -g ApiCourier.CLI

Then:

apicourier --help

Requires the .NET 10 runtime. Windows, macOS and Linux.

Running things

apicourier run request "Get User"
apicourier run collection "Smoke Tests"
apicourier run flow "Checkout"
apicourier run query "Active Accounts" --profile staging

Useful options:

Running SQL queries

run query runs a saved SQL query headlessly against a connection profile — the same execution the app uses, including pre-request and post-response scripts. It takes the shared options above and adds its own:

apicourier run query "Active Accounts" --profile "Orders DB" --env staging --format csv --row-limit 500

Connection passwords are never stored in the workspace. In a headless run the CLI reads them from the OS secret store or from an APICOURIER_SECRET_<connectionId> environment variable; if the secret is missing it exits with code 3 and prints the exact variable name to set.

In CI

The JUnit reporter is understood by most CI systems, so failed requests and failed script assertions show up as test results rather than as a wall of log output:

apicourier run collection "Smoke Tests" --env ci --reporter junit --out ./test-results

Exit codes are stable, so the process status is meaningful on its own.

Workspaces

apicourier workspace init ./my-workspace --git
apicourier workspace info
apicourier workspace validate
apicourier workspace sync
apicourier env list

workspace sync reloads the local cache from the YAML on disk — run it after a git pull. workspace validate is a useful pipeline gate: it fails when a workspace file is malformed, which catches unresolved merge conflict markers before a run does.

Scripts

Pre-request and post-response scripts run in the CLI as they do in the app, in both C# and JavaScript. C# scripts execute in a sandboxed worker process and are blocked in a workspace you have not trusted; pass --trust-scripts (or set APICOURIER_TRUST_SCRIPTS=1) to allow them in automation. A declared script that was blocked and never ran fails the run rather than being silently skipped.

Licensing

ApiCourier is commercial software with a free tier that covers the desktop app and this CLI for personal or internal business use — no subscription, no account, no time limit. Paid tiers unlock additional features.

See apicourier.dev/license for the licensing model and apicourier.dev/terms for the Terms of Service, which are the controlling agreement.

Links

• Documentation
• apicourier.dev
• Third-party notices