CLI

Read the catalog, vote on requests and manage your listings from a terminal. Add --json to get a validated JSON result on stdout. Errors and pagination hints go to stderr.

Run from a source checkout

Run these commands from the repository root after pnpm install.

Local CLI search
pnpm --filter @workspace/cli build
export OPENCOUPLER_API_URL='https://opencoupler.com'
node packages/cli/dist/index.mjs search medistar --json
Use npx after npm publication

The package is currently available from the source checkout. Use this command once it is published.

Future npx usage
OPENCOUPLER_API_URL='https://opencoupler.com' npx opencoupler search medistar --json

Authenticate

Create a key with the read scope in Settings for catalog reads. Add write:requests for request commands or write:listings for provider commands. Paste the key into the hidden prompt. The CLI stores it in your user config directory with owner-only permissions. An environment variable named OPENCOUPLER_API_KEY overrides the saved key.

Local CLI authentication
node packages/cli/dist/index.mjs login
node packages/cli/dist/index.mjs whoami
node packages/cli/dist/index.mjs logout

Buyer agent example

With jq and a key with read and write:requests, find an integration, read its listing, and record a specific need. Run the write commands only for a real need. Creating a request casts the first vote, so voting again as the same user returns already_voted.

Search, read, create and vote
node packages/cli/dist/index.mjs search medistar --json
listing_id=$(node packages/cli/dist/index.mjs system cgm-medistar --json | jq -r '.listings[0].publicId')
node packages/cli/dist/index.mjs listing "$listing_id" --json
request_id=$(node packages/cli/dist/index.mjs request create --system cgm-medistar --title 'Medication export for our clinic' --use-case 'We need to check prescription changes before transfer.' --idempotency-key "$(node -p 'crypto.randomUUID()')" --json | jq -r '.id')
node packages/cli/dist/index.mjs request vote "$request_id" --json

Commands

login
Verify and save an API key for this API URL. Paste it at the hidden prompt or use the API key environment variable.
logout
Remove the saved API key.
whoami
Show the API key owner and scopes.
search <query>
Search published systems. Filter with --industry, --country or --availability.
system <slug>
Show a system and its published integrations.
listing [provider/listing]
Show one integration by its public ID.
providers
List public provider profiles.
requests
List public demand requests.
request create
Create a request with --system <slug> or --propose <name>. Add --title, --use-case or --idempotency-key.
request vote <id>
Vote for a request as the key owner.
request unvote <id>
Remove the key owner's vote.
request note <id> --body <text>
Add a public use-case note.
listing init <system-slug>
Write a commented JSON listing file. Use --output <file> to set the filename.
listing push <file>
Save a working copy. Use --dry-run to check editor fields locally before submitting.
listing submit <slug> --confirm
Confirm accuracy and accept the terms, then send the draft to a human reviewer.
listing status [slug]
Show your listings and their review states.
listing unlist <slug>
Take your published listing off the public catalog.
mcp-config
Print a Streamable HTTP MCP configuration for this API URL.