CLI reference

Each page is generated from capxul schema <command>, which reads the command's own definition. The CLI prints the same facts: run capxul schema for every command, or add --help to one command.

Global flags

| Flag | Type | Description | | ----------------------- | ---------- | ----------------------------------------------------------- | ----- | ---- | ------------------------------------------------------------ | ------- | ----- | ----- | ------ | ------------------------------------------------------------------------------------------------ | | --help, -h | boolean | Show help information | | --version, -v | boolean | Show version information | | --wizard | boolean | Start wizard mode for a command | | --completions | <bash | zsh | fish | sh> | Print shell completion script (choices: bash, zsh, fish, sh) | | --log-level | <all | trace | debug | info | warn | warning | error | fatal | none> | Sets the minimum log level (choices: all, trace, debug, info, warn, warning, error, fatal, none) | | --json | boolean | Print a versioned JSON result | | --no-input | boolean | Never ask for terminal input or open a browser | | --org | <handle> | act as this organization for one command | | --env | <name> | use this environment for one command | | --accept-experimental | boolean | accept that production is experimental and moves real money | | --fields | <a,b> | choose which JSON fields come back |

Exit codes

Each error code has one exit code.

Commands

whoami

• capxul whoami: you, who you're acting as, environment

use

• capxul use personal: Act as yourself
• capxul use org: Act as one of your Organizations
• capxul use env: Use this environment from now on

auth

• capxul auth login: Sign in with your email and a one-time code
• capxul auth verify: finish signing in (scripts and agents)
• capxul auth list: List the people signed in on this machine
• capxul auth switch: Switch to another person signed in on this machine
• capxul auth logout: Sign out on this device

account

• capxul account show: Read your Account lifecycle without starting setup
• capxul account retry: Find where to finish setting up your Account

balance

• capxul balance: balances for whoever you're acting as

address

• capxul address: where to send crypto to this account

verify

• capxul verify start: Start or continue verification; --input supplies answers, file paths, and business people
• capxul verify status: Show the exact verification step or the approval for each currency

bank

• capxul bank details: Show bank details people can pay
• capxul bank deposits: List bank deposits
• capxul bank match: Match a bank deposit to a request
• capxul bank settle: Choose the token a bank deposit becomes
• capxul bank accounts: List and manage your saved bank accounts
• capxul bank accounts add: Save your bank account; private values can come from --input FILE|-
• capxul bank accounts remove: Remove one of your saved bank accounts
• capxul bank pay: Pay a bank account; approve in your browser (moves money)

payment

• capxul payment send: you approve it in the browser (moves money)
• capxul payment list: Payments sent and received
• capxul payment get: Read one exact Payment
• capxul payment wait: Follow a Payment, or the approval ID a write returned, until it ends
• capxul payment retry: retry the exact Payment; you approve it in the browser (moves money)

inbox

• capxul inbox list: List this actor's payment requests and document references
• capxul inbox get: Inspect one payment request and its document references
• capxul inbox pay: pay a received request; you approve it in the browser (moves money)
• capxul inbox decline: Decline a received payment request

request

• capxul request issue: ask someone to pay you
• capxul request list: List this actor's payment requests and document references
• capxul request get: Inspect one payment request and its document references
• capxul request cancel: Cancel an issued payment request

offer

• capxul offer list: List fixed offers
• capxul offer get: Get fixed offers
• capxul offer create: Create fixed offers
• capxul offer revise: Revise fixed offers
• capxul offer deactivate: Deactivate fixed offers

agreement

• capxul agreement list: The agreements that pay you, from every Organization, or that pay --org's Safe: earned, collectable and the next release. The department's side is org agreement list
• capxul agreement show: One agreement that pays you, or --org's Safe: who pays, the rate, its state, the terms and their hash, earned and collectable
• capxul agreement accept: Accept an offer by signing its exact terms hash from your own Safe, or with --org as an Owner proposal on your Organization's Safe; pay builds up from the start date or now
• capxul agreement collect: Collect everything released: the payer pays it as one Payments V3 payment. With --org, an Owner proposal on your Organization's Safe. With nothing released, nothing is signed

contact

• capxul contact list: List contacts in the selected actor's address book
• capxul contact get: Read one contact by stable PartyId
• capxul contact add: Add one contact from AddressBookAddInput JSON
• capxul contact label: Change one contact label by stable PartyId
• capxul contact hide: Hide one contact
• capxul contact unhide: Restore one contact
• capxul contact bank add: Save a private bank account for an existing contact

document

• capxul document get: Read exact document bytes and metadata
• capxul document verify: Check an authorized document
• capxul document render: Save a verified document as PDF
• capxul document export: Save original document bytes to a new file

activity

• capxul activity list: List exact authorized activity with a cursor
• capxul activity get: Read one exact Payment or Movement
• capxul activity summary: Summarize exact raw-unit activity totals
• capxul activity annotate: Give a row its account and memo, from flags or JSON input

invite

• capxul invite list: invitations you've received
• capxul invite accept: Verify yourself for a business invite, or accept one exact permission offer by its current digest
• capxul invite decline: Decline your own pending offer; starts its cleanup

org

• capxul org list: List current Organization access
• capxul org create: Create one Organization, or resume the exact one this machine recorded
• capxul org show: Read the exact Organization lifecycle
• capxul org me: Read your standing in the Organization
• capxul org wait: Poll the lifecycle until ready or failed; never retry setup
• capxul org retry: Resume this exact Organization setup lane; never creates one
• capxul org member list: List members, including pending members
• capxul org member get: Read one member by exact Account ID
• capxul org member invite: Invite one person; any grant offered is approved in the browser, a Seat alone needs no approval. --preview writes nothing
• capxul org member grant: Give a Seat a permission. An Owner grants it, off chain; it never moves money
• capxul org member revoke: Take a permission back from a Seat. An Owner revokes it
• capxul org invite list: invitations you've sent
• capxul org invite cancel: Cancel a pending offer you administer; starts its cleanup
• capxul org invite resend: Retry delivery of a verified pending offer; never extends expiry
• capxul org permission list: List active and pending Permissions
• capxul org permission get: Read one exact Permission
• capxul org permission create: Propose a Permission from its complete policy to the Owners; you approve it in the browser
• capxul org permission change: Propose one active Permission's complete new policy to the Owners; you approve it in the browser
• capxul org permission assign: Propose assigning one active Permission to one exact Account; you approve it in the browser
• capxul org permission revoke: Propose revoking one exact active Permission assignment; you approve it in the browser
• capxul org permission replace: Replace the current Roles module with its complete authority scope; you approve it in the browser
• capxul org payroll groups list: List saved roster drafts in one Organization
• capxul org payroll groups save: Create or replace one complete Payroll roster draft
• capxul org payroll groups remove: Remove one exact Payroll roster draft
• capxul org payroll terms: Read raw engagement terms without calculating pay
• capxul org payroll list: List Payroll runs and backend monthly totals
• capxul org payroll run: run payroll from a Budget; you approve it in the browser (moves money)
• capxul org payroll get: Read one exact Payroll run and its ordered Payments
• capxul org payroll wait: Observe one exact Payroll run without submitting Payments
• capxul org department create: Propose a department, its yearly payroll budget and its holders to the Owners
• capxul org department show: A department: its budget, what is committed, its holders and agreements
• capxul org department list: The Organization's departments, with their budgets and holders
• capxul org department budget set: Propose a department's new yearly budget; the payout ceiling is resized with it
• capxul org department holder add: Propose one more holder for a department
• capxul org department holder remove: Propose taking a holder off a department; their agreements stay with it
• capxul org department ceiling set: Propose the payout ceiling every department pays within; what this period paid stays paid
• capxul org department ceiling freeze: Propose a payout freeze: the ceiling keeps --leave, with no refill until unfrozen; payees stay owed
• capxul org department ceiling unfreeze: Propose the unfreeze: the yearly ceiling back, less all of --leave; any unspent part of it is forfeited, so nothing pays twice
• capxul org agreement offer: Offer a payee a salary, a stream or a retainer from a department's payroll budget
• capxul org agreement withdraw: Take back an offer the payee has not accepted; its budget frees at once
• capxul org agreement change: Raise an agreement's rate now, or lower it from a date; give the rate flag it was offered with. --cancel cancels a waiting lowering
• capxul org agreement pause: Stop an agreement's pay from building up; earned pay stays collectable and the budget does not change
• capxul org agreement resume: Start a paused agreement's pay building up again from now
• capxul org agreement end: Set the last day an accepted agreement pays; its budget frees the day after
• capxul org agreement list: The Organization's payment agreements by department: payee, kind, yearly rate and status
• capxul org books accounts list: The chart of accounts, in code order
• capxul org books accounts import: Make the chart from a template, once. Needs Manage books
• capxul org books accounts add: Add an account. Needs Manage books
• capxul org books accounts rename: Rename or renumber an account. Needs Manage books
• capxul org books accounts archive: Archive an account: it takes no new rows. Needs Manage books
• capxul org books accounts review: The rows waiting in a not-decided account; --accept makes a suggestion an account
• capxul org books facts list: The books' facts, oldest first
• capxul org books assets list: Every token the books record, Capxul's own first
• capxul org books assets add: Add an ERC-20 your Safe holds: Capxul checks it on the chain and books its transfers from now on, with no USD. Needs Manage books
• capxul org books assets remove: Stop recording a token you added; the facts it booked stay. Needs Manage books
• capxul org owner list: Who the Owners are and how many must approve every change
• capxul org owner add: Propose making a member an Owner, then approve it in your browser
• capxul org owner remove: Propose that someone stops being an Owner; they stay a member. Then approve it in your browser
• capxul org owner replace: Propose swapping one Owner for a member in one step, then approve it in your browser
• capxul org owner threshold: Propose how many Owners must approve every change, then approve it in your browser
• capxul org proposal list: Proposals, newest nonce first
• capxul org proposal get: One proposal: its calls, who approved, and its status on the chain
• capxul org proposal approve: Approve it in your browser; the approval that reaches the threshold executes it
• capxul org proposal reject: Propose its rejection, then approve that in your browser
• capxul org proposal wait: Wait until no approval of it is still on its way to the chain

config

• capxul config telemetry on: Turn on usage and diagnostics collection
• capxul config telemetry off: Turn off usage and diagnostics collection
• capxul config telemetry status: Show whether this CLI collects usage and diagnostics

schema

• capxul schema: every command, flag and output as JSON

doctor

• capxul doctor: Check local configuration; --online also checks the backend

dev

• capxul dev key: a sandbox publishable key for your app, in .env.local
• capxul dev fund: test money into your own Safe, or an Organization's with --org
• capxul dev time: show both devnet clocks: the chain and the backend
• capxul dev time warp: move the chain and backend clocks forward together
• capxul dev time start-at: set the story in the past, once, before it begins: both clocks move back
• capxul dev jobs run: run each backend job once, now
• capxul dev snapshot save: save the chain, the backend data and the indexer
• capxul dev snapshot list: the saved snapshots, by world time
• capxul dev snapshot restore: put the chain, the backend data and the indexer back
• capxul dev mail list: the sent mail, newest first
• capxul dev mail notices: each notice's delivery: sent, retrying or failed
• capxul dev mail fail: make the next sink writes fail as a provider refusal
• capxul dev approve: sign an open approval as a person, with their dev signer
• capxul dev gates set: turn a feature gate on or off for the Organization --org names
• capxul dev prices set: script the USD rate a pair has, for the facts written after