CLI

The hedge CLI is the fastest way for a broker to work with Hedge from a terminal or a script. It wraps the REST API and handles OAuth 2.1 sign-in and token refresh for you. Source lives at github.com/taventech/hedge-cli.

Install

npm

npm i -g hedge-broker

Homebrew

brew install taventech/tap/hedge

curl

curl -fsSL https://github.com/taventech/hedge-cli/releases/latest/download/install.sh | sh

Sign in

hedge login

By default hedge login uses the OAuth 2.1 device flow: it prints a short code and a URL, you approve the sign-in in the broker portal, and the CLI stores a short-lived token. On a machine with a browser, sign in with a loopback redirect instead:

hedge login --browser

Check who you are signed in as at any time with hedge whoami. For the full auth model, see Authentication.

Command reference

Run hedge <command> --help for flags and examples on any command.

Command	What it does
hedge whoami	Show the signed-in broker and brokerage for the current token.
hedge appetite <query>	Check which markets want a class of business. Narrow with --state and --lob.
hedge submit	Create a submission from an applicant and lines of business.
hedge upload	Attach documents (ACORDs, loss runs, supplements) to a submission.
hedge requirements	Show what a submission still needs, per market and per carrier question.
hedge finalize	Hand a submission to Hedge to market to carriers.
hedge status	Show the current state of a submission.
hedge submissions	List your submissions.
hedge quotes	List the carrier API quote sessions on a submission.
hedge answer	Answer outstanding carrier questions on a quote session.
hedge request-quote	Start or refresh an instant carrier quote for a submission.
hedge policies	List your bound policies, or show one with its documents.
hedge payments	List commission payments and payout status.

Tip

Add --json to any command for machine-readable output. This makes the CLI easy to pipe into jq or wire into a script.

hedge appetite "roofing" --state CA --json | jq '.markets[].name'

A typical flow

1. Check appetite for the class and state:

   hedge appetite "roofing" --state CA

2. Create the submission:

   hedge submit --insured "Acme Roofing LLC" --state CA --line "General Liability"

3. Upload supporting documents and confirm readiness:

   hedge upload <submission-id> ./acord-125.pdf ./loss-runs.pdf
   hedge requirements <submission-id>

4. Hand it to Hedge to market:

   hedge finalize <submission-id>

5. Track progress and read results:

   hedge status <submission-id>
   hedge quotes <submission-id>
   hedge policies

CLI on GitHubSource, releases, and the install script for the hedge CLI.