CLI

capsure is a client of the Platform API. It stores a token and calls /api/v1/x. It does not take a raw path, and it cannot do something the API refuses.

Examples use Harbor Lane Capital. The API address is the host your firm was given.

Install

Download the build for the machine that will run it.

System	File
Windows	capsure-win-x64.exe
Linux	capsure-linux-x64
macOS (Apple silicon)	capsure-osx-arm64

On Linux and macOS, mark the file executable before the first run. The command is capsure.

A machine with the .NET SDK can install the tool package instead. Save the file in an empty folder, then from that folder:

dotnet tool install --global --add-source . Capsure.Cli

Sign in

Issue a token in Administration → API tokens. Scopes and what they allow are on Authentication.

capsure login --api https://api.capsuresoftware.com --token cap_...
capsure whoami

whoami prints the person and the firm. It does not print the secret.

The token is stored in credentials.json under .capsure in the home directory. CAPSURE_TOKEN overrides the stored token for one process. CAPSURE_API overrides the stored address.

An API token stays on the firm it was issued for. A session from login --api <url> --id-token <jwt> can list firms with capsure tenants and open another firm this email already belongs to with capsure switch <tenant-id>.

capsure logout deletes the stored file.

Commands

Each command is one route. The pages linked here describe the body and the errors. -o <file> writes the JSON response to a file. A body is a JSON file.

Command	Page
capsure catalog	Catalog
capsure openapi	The route list. Field schemas stay on the catalog
capsure search <text>	Search
capsure records list Company	Records
capsure funds list	Funds
capsure funds push fund.json	Funds
capsure commitments push <fund-id> --file commitment.json	Funds
capsure portfolio companies	Portfolio
capsure portfolio value --fund <id>	Portfolio
capsure changes	Changes
capsure records create Company --file company.json	Records
capsure fields create --file field.json	Custom fields
capsure views list companies	Saved views
capsure automations push flow.json	Automations. This saves a draft
capsure automations publish <id>	Automations. A high-impact tree stays a draft
capsure forms push form.json	Forms
capsure forms version <id> --file version.json	Forms
capsure agents push agent.json	Agents
capsure agents get <id>	Agents
capsure quick-actions push action.json	Quick actions
capsure processes push process.json	Processes
capsure strategies push strategy.json	Strategies
capsure sources push source.json	Deal sources
capsure attribute-sets push set.json	Attribute sets
capsure reports push report.json	Reports
capsure tasks list	Workspace
capsure users list	Workspace
capsure firms list	Workspace
capsure taxonomy list sectors	Product screens
capsure portal access	Product screens
capsure products list <company-id>	Product screens
capsure company-investors list <company-id>	Product screens
capsure esg-requests list --period <id>	Product screens
capsure campaigns list	Product screens
capsure meetings list	Product screens
capsure audit-log list	Product screens
capsure projection-templates push template.json	Product screens
capsure usage	Product screens
capsure addresses list <company-id>	What a person fills in
capsure deals terms <deal-id>	What a person fills in
capsure deals next-ups <deal-id>	What a person fills in
capsure deals decision <deal-id>	What a person fills in
capsure documents upload <file> --entity Company --id <entity-id>	What a person fills in
capsure report-templates push template.json	Reports
capsure connectors push connector.json	Connectors. This saves an inactive draft
capsure imports list --project <id>	Imports
capsure imports push import.json	Imports

capsure --help lists every command, including get, update, activate, and delete.

A failed call prints the HTTP status, the error code, and the detail. A missing scope includes the scope name. The codes are on Errors.