CLIorg
capxul org member invite
Invite one person; any grant offered is approved in the browser, a Seat alone needs no approval. --preview writes nothing
Runs in: devnet · staging · production · Moves money: no
Usage
capxul org member invite [flags] [<email>]Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
<email> | string | no | Who to invite, by email (or use --account-id) |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--account-id | string | no | Recipient Account (or email) |
--budget-id | string | yes | Existing Budget ID |
--permission-id | string | yes | Manage-people Permission ID |
--new-budget-name | string | no | New Budget label |
--asset | string | no | New Budget asset |
--limit | string | no | New Budget cap (or unlimited) |
--unlimited | boolean | no | New Budget unlimited cap |
--recipient-account | string | yes | New Budget allowed Account |
--any-recipient | boolean | no | New Budget any recipient |
--actions | string | yes | New Budget actions: pay |
--agent | boolean | no | mark the Seat as an AI agent, shown in member lists and on books facts |
--permission | string | yes | an off-chain permission the Seat holds once it joins: manage-books |
--email | string | no | the signed-in person to use, when this machine has several |
--request-key | string | no | a key that makes repeating the same invitation safe |
--preview | boolean | no | show what would be authorized and write nothing |
--timeout-seconds | integer | no | how long to follow it (default: until the approval lapses) |
Every command also takes the global flags.
Returns
The data of the result that --json prints:
--json: { status: 'awaiting_approval', approvalId, approvalUrl, paymentIds: [], expiresAt, requestKey, next: { argv } }; a person: InvitationView; --preview: InvitePreviewErrors
Generated from capxul schema org member invite.