Reference
CLI
Run a capability
node src/ticket16/cli.mjs <capabilityId> [jsonPayload]. The key comes from TRUMPET_API_KEY in the environment. The payload is one JSON object as the second argument.
export TRUMPET_API_KEY=trk_...
node src/ticket16/cli.mjs ticket6:readLedger '{}'A success prints the result as one JSON line and exits 0.
{"balanceMinor":3000,"currency":"USD","entries":[...]}A refusal prints one code on stderr and exits 1. There is no message, because a message can quote a connection string or a key.
{"error":"ACCESS_REFUSED"}- Exit 0 means the capability ran.
- Exit 1 means a refusal. The code is on stderr.
- Exit 2 means the arguments were wrong, or the payload was not a JSON object.
Operator commands
These run in process with the runtime environment. Each one is a person at a terminal, not an agent.
- npm run migrate
- Applies the migrations. It takes a separate owner connection in
TRUMPET_MIGRATION_DATABASE_URL, because migrations create roles and policies that the runtime role must not be able to create. - npm start
- Runs the poller and the served listener. It reads
TRUMPET_DATABASE_URL,STRIPE_RESTRICTED_KEY,TRUMPET_WORKSPACEandTRUMPET_PROGRAM, plusTRUMPET_API_KEY_PEPPERfor the served surface. - npm run held
list,replay <evt_id>andclose <evt_id> --reason <text> --correction <ref>. Replay and close are human gates. The operator identity comes fromTRUMPET_OPERATORand is recorded on each row the command resolves.- npm run approvals
list,approve <request_id>andreject <request_id> --reason <text>. The operator approval channel. It runs as a human actor on the cli surface. No served key, MCP key or partner read can produce that actor.- npm run workspace:create
- Creates a workspace and prints its first service key once. It refuses the runtime connection and demands a separate least privilege operator connection in
TRUMPET_OPERATOR_DATABASE_URL. - npm run golive:check
- A read only preflight. It writes nothing.
Capabilities on the cli surface
93 capabilities declare the cli surface. The CLI lists only the automation safe ones as commands. A human gate still refuses an agent and creates an approval request.
Generated from shyftai/trumpet at cbc30f1 by scripts/gen-reference.mjs.
approvals
6 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| approvals:approveRequest | Writes | Human gate | api cli web | No |
| approvals:getApprovalRequest | Reads | Agent | api cli mcp | Yes |
| approvals:listApprovalRequests | Reads | Agent | api cli mcp | Yes |
| approvals:rejectRequest | Writes | Human gate | api cli web | No |
| approvals:requestApproval | Writes | Agent | api cli mcp | Yes |
| approvals:withdrawRequest | Writes | Agent | api cli mcp | Yes |
campaigns
7 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| campaigns:approveCampaign | Writes | Human gate | api cli mcp web | Yes |
| campaigns:draftCampaign | Writes | Agent | api cli mcp | Yes |
| campaigns:getAdapter | Reads | Agent | api cli mcp | Yes |
| campaigns:getCampaign | Reads | Agent | api cli mcp | Yes |
| campaigns:launchCampaign | Writes | Human gate | api cli mcp web | Yes |
| campaigns:listCampaigns | Reads | Agent | api cli mcp | Yes |
| campaigns:setupAdapter | Writes | Human gate | api cli mcp web | Yes |
discovery
3 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| discovery:getResultPage | Reads | Agent | api cli mcp | No |
| discovery:listCreatorRecords | Reads | Agent | api cli mcp | No |
| discovery:listRuns | Reads | Agent | api cli mcp | No |
partners
3 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| partners:grantAccess | Writes | Human gate | api cli mcp | Yes |
| partners:revokeGrant | Writes | Agent | api cli mcp | Yes |
| partners:setGuardrail | Writes | Agent | api cli mcp | Yes |
runtime
3 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| runtime:closeHeldEvent | Writes | Human gate | api cli mcp | Yes |
| runtime:listHeldEvents | Reads | Agent | api cli mcp | Yes |
| runtime:replayHeldEvent | Writes | Human gate | api cli mcp | Yes |
ticket1
1 capability
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket1:getWorkspaceConfig | Reads | Agent | api cli mcp | Yes |
ticket10
3 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket10:ingestStripeEvent | Writes | Agent | api cli mcp | Yes |
| ticket10:invokeStripe | Writes | Agent | api cli mcp | Yes |
| ticket10:queryIngestionState | Reads | Agent | api cli mcp read | Yes |
ticket11
1 capability
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket11:queryPartnerBalance | Reads | Agent | api cli mcp read | Yes |
ticket12
1 capability
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket12:queryReconciliationReport | Reads | Agent | api cli mcp read | Yes |
ticket13
2 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket13:commitCutover | Writes | Human gate | api cli mcp | Yes |
| ticket13:queryCutoverState | Reads | Agent | api cli mcp read | Yes |
ticket15
5 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket15:assignReferralCode | Writes | Human gate | api cli mcp | Yes |
| ticket15:publishReferralLink | Writes | Agent | api cli mcp | Yes |
| ticket15:queryReferralClicks | Reads | Agent | api cli mcp read | Yes |
| ticket15:resolveAndRecordClick | Writes | Agent | api cli mcp | Yes |
| ticket15:revokeReferralLink | Writes | Agent | api cli mcp | Yes |
ticket16
3 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket16:createApiKey | Writes | Human gate | api cli web | Yes |
| ticket16:listApiKeys | Reads | Agent | api cli mcp read | Yes |
| ticket16:revokeApiKey | Writes | Agent | api cli mcp | Yes |
ticket17
2 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket17:invitePartnerFromCrispy | Writes | Agent | api cli mcp | Yes |
| ticket17:readPartnerEarnings | Reads | Agent | api cli mcp | Yes |
ticket18
4 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket18:createWorkspace | Writes | Human gate | cli | Yes |
| ticket18:getWorkspace | Reads | Agent | api cli mcp read | Yes |
| ticket18:issueWorkspaceKey | Writes | Human gate | api cli web | Yes |
| ticket18:listWorkspaces | Reads | Agent | api cli mcp read | Yes |
ticket19
8 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket19:bindReferrer | Writes | Agent | api cli mcp | Yes |
| ticket19:compareShadowCredits | Reads | Agent | api cli mcp read | Yes |
| ticket19:issueCustomerCode | Writes | Agent | api cli mcp | Yes |
| ticket19:queryReferralState | Reads | Agent | api cli mcp read | Yes |
| ticket19:recordCustomerIdentity | Writes | Agent | api cli mcp | Yes |
| ticket19:recordCustomerPayment | Writes | Agent | api cli mcp | Yes |
| ticket19:recordCustomerRefund | Writes | Agent | api cli mcp | Yes |
| ticket19:recordInvoicePaymentLink | Writes | Agent | api cli mcp | Yes |
ticket4
7 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket4:acceptStandardTerms | Writes | Human gate | api cli mcp web | Yes |
| ticket4:completeOnboarding | Writes | Agent | api cli mcp | Yes |
| ticket4:configureProgram | Writes | Agent | api cli mcp | Yes |
| ticket4:createProgram | Writes | Agent | api cli mcp | Yes |
| ticket4:getProgram | Reads | Agent | api cli mcp | Yes |
| ticket4:getRelationship | Reads | Agent | api cli mcp | Yes |
| ticket4:invitePartner | Writes | Agent | api cli mcp | Yes |
ticket5
6 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket5:evaluateAttribution | Reads | Agent | api cli mcp | Yes |
| ticket5:issueCoupon | Writes | Agent | api cli mcp | Yes |
| ticket5:issueReferralLink | Writes | Agent | api cli mcp | Yes |
| ticket5:queryCoupon | Reads | Agent | api cli mcp | Yes |
| ticket5:queryReferralLink | Reads | Agent | api cli mcp | Yes |
| ticket5:readReferralProjection | Reads | Agent | api cli mcp read | Yes |
ticket6
20 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket6:activatePartnerOverride | Writes | Human gate | api cli mcp web | No |
| ticket6:activateRulebookVersion | Writes | Human gate | api cli mcp web | Yes |
| ticket6:applyPartnerGroupTerms | Writes | Agent | api cli mcp | No |
| ticket6:approveCommission | Writes | Human gate | api cli mcp web | Yes |
| ticket6:approveCommissions | Writes | Human gate | api cli mcp web | Yes |
| ticket6:changePartnerGroupMembers | Writes | Agent | api cli mcp | No |
| ticket6:configureCommissionPolicy | Writes | Human gate | api cli mcp web | Yes |
| ticket6:createPartnerGroup | Writes | Agent | api cli mcp | No |
| ticket6:draftPartnerOverride | Writes | Agent | api cli mcp | No |
| ticket6:draftRulebookVersion | Writes | Agent | api cli mcp | Yes |
| ticket6:ingestSourceEvent | Writes | Agent | api cli mcp | Yes |
| ticket6:queryCommissionPolicies | Reads | Agent | api cli mcp read | Yes |
| ticket6:queryPartnerGroups | Reads | Agent | api cli mcp read | No |
| ticket6:queryPartnerOverride | Reads | Agent | api cli mcp read | No |
| ticket6:queryPendingAccruals | Reads | Agent | api cli mcp read | Yes |
| ticket6:queryRulebook | Reads | Agent | api cli mcp read | Yes |
| ticket6:readLedger | Reads | Agent | api cli mcp read | Yes |
| ticket6:readPartnerProgress | Reads | Agent | api cli mcp read | No |
| ticket6:rejectCommission | Writes | Human gate | api cli mcp web | Yes |
| ticket6:rejectCommissions | Writes | Human gate | api cli mcp web | Yes |
ticket7
8 capabilities
| Capability | Access | Who runs it | Surfaces | Served |
|---|---|---|---|---|
| ticket7:createManualCorrection | Writes | Human gate | api cli mcp web | Yes |
| ticket7:explainEntries | Reads | Agent | api cli mcp read | Yes |
| ticket7:queryBalances | Reads | Agent | api cli mcp read | Yes |
| ticket7:queryPayoutStatement | Reads | Agent | api cli mcp read | Yes |
| ticket7:recordCarriedDebtRecovery | Writes | Human gate | api cli mcp web | Yes |
| ticket7:recordDisputeTransition | Writes | Human gate | api cli mcp web | Yes |
| ticket7:recordPayoutReceipt | Writes | Human gate | api cli mcp web | Yes |
| ticket7:recordStatementPayout | Writes | Human gate | api cli mcp web | Yes |