Skip to main content
Command reference

All commands

Every command the published @codespar/cli exposes, by group, with the count each group carries.

3 min read
View MarkdownEdit on GitHub

@codespar/cli 0.16.0 exposes 134 commands, under 40 top-level entries.

This page enumerates. The task pages (Money, Mandates and governance, Catalog and discovery) teach, with a worked example and real output for each.

GroupCommandsWhat it does
Direct commands20—
codespar servers2Browse the server catalog
codespar tools3Inspect tools exposed by servers
codespar consumers31Consumers: profile, Pix keys, Pix lookups, receipts, contact verification
codespar boletos4DDA boletos: subscribe a document, list the boletos it receives
codespar sellers6Sellers: onboarding status, custody, pending settlement, ledger
codespar mcp-servers8Tenant MCP servers: register, validate, list, patch a tool, sweep platform fees
codespar wallets15Wallets: balances, ledger, funding sources, execute, transfer, custody
codespar triggers12Webhook endpoints: deliveries, DLQ, secret rotation, redelivery
codespar charges5Charges: issue one, read it, list them, withdraw one
codespar consents4Consent tokens: mint the token whose URL the consumer opens to authorise an agent
codespar consumer-payments2Consumer payments: execute a payment on a consumer's behalf, with the audit chain (execute-stream returns SSE)
codespar catalog1Catalog: search it for a capability by intent
codespar payables5Payables: submit one (structured or manual), read its state and trail
codespar test4Sandbox money (test keys only): credit a consumer directly, or mint a Pix charge and settle it
codespar sessions3Inspect and manage sessions
codespar connect3Manage Connect Links for end-user provider OAuth
codespar mandate3Create and manage consumer mandates (the agent's allowance / wallet)
codespar audit1Read the tamper-evident audit chain
codespar logs1Inspect tool-call execution logs
codespar agent1Run an agent directory: reads its agent.yaml (schema 1) and delegates to the directory's own npm start

What a command prints

Every command under a group page is derived from one HTTP operation and prints what that operation answered. The direct commands are written by hand and shape their own tables, but read --json the same way.

The route it called goes to stderr, so a pipe never sees it:

stderr
ℹ GET /v1/wallets

On stdout, the payload. A bare list, or an object with exactly one list field, becomes a table over the scalar fields its items share, up to six columns, and whatever else the payload carries prints as JSON below it:

stdout
id     display_name  currency  status
wal_1  Example       BRL       active

{
  "total": 1
}

Everything else prints as JSON: an object with no list, one with two lists, or one whose single list came back empty. Nested fields never become columns. A value longer than the column prints clipped, and a line below the table says how many were clipped, so a cut cell is never silent.

--json replaces all of that with the payload verbatim, and is what a script should read. A 204 answer prints (no content) on stderr and nothing on stdout.

Exit codes and the shape of a failure are in Configuration.

All commands | CodeSpar