@capxul/cli 4.20.0-beta.6 → 4.20.0-beta.8

package/README.md

@@ -1,9 +1,9 @@
 # Capxul CLI
 
 The CLI provides email OTP login, persistent first-party sessions, terminal-owned
-signup, a bundled Openfort wallet page, backend profile and account reads,
-diagnostics, and one global collection preference. It requires Node 24 or later
-on macOS or Linux.
+signup, personal and Organization contacts, a bundled Openfort wallet page,
+backend profile and account reads, diagnostics, and one global collection
+preference. It requires Node 24 or later on macOS or Linux.
 
 ```sh
 capxul --help
@@ -24,6 +24,51 @@ machinery and collection controls send no observation records.
 check uses the public Capxul SDK and verifies the backend response nonce.
 It does not authenticate a person or submit a transaction.
 
+## Contact commands
+
+```sh
+capxul contact list [--include-hidden]
+capxul contact get --entry-id PARTY_ID
+capxul contact add --input FILE|- [--confirm]
+capxul contact label --entry-id PARTY_ID --label TEXT [--confirm]
+capxul contact hide --entry-id PARTY_ID [--confirm]
+capxul contact unhide --entry-id PARTY_ID [--confirm]
+
+capxul org contact list --org ORGANIZATION_ID [--include-hidden]
+capxul org contact get --org ORGANIZATION_ID --entry-id PARTY_ID
+capxul org contact add --org ORGANIZATION_ID --input FILE|- [--confirm]
+capxul org contact label --org ORGANIZATION_ID --entry-id PARTY_ID --label TEXT [--confirm]
+capxul org contact hide --org ORGANIZATION_ID --entry-id PARTY_ID [--confirm]
+capxul org contact unhide --org ORGANIZATION_ID --entry-id PARTY_ID [--confirm]
+```
+
+Personal commands use the authenticated Account address book. Organization
+commands require one explicit `--org` or `--org-id`; they never use the saved
+Organization read default. `list` omits hidden entries unless
+`--include-hidden` is present. `get`, `label`, `hide`, and `unhide` address one
+stable Party with `--entry-id`.
+
+`add --input` reads the existing `AddressBookAddInput` JSON shape. For example:
+
+```json
+{
+  "ref": { "kind": "email", "email": "supplier@example.test" },
+  "label": "New Supplier"
+}
+```
+
+Use `--input -` to read the same object from stdin. An interactive `add` can
+collect the reference kind, value, and optional label instead. Interactive
+writes show the actor and exact contact change, then ask a default-no question.
+JSON, CI, and other noninteractive writes require `--confirm` before the CLI
+creates a client. Contact writes do not start a browser signer.
+
+Success data is the SDK value without a CLI wrapper: `list` returns
+`AddressBookEntry[]`, `get` returns `AddressBookEntry | null`, and each mutation
+returns `AddressBookEntry`. Human `get` prints `No contact found` for null and
+exits successfully. Entries retain their stable PartyId, exact reference,
+relationships, hidden state, and last activity time.
+
 ## Organization commands
 
 ```sh
@@ -44,6 +89,14 @@ These commands accept `--email`. Without it, they restore the protected current
 session. Organization reads accept `--org` or its alias `--org-id`. Identical
 repeated IDs are accepted. Different IDs are refused.
 
+A read without `--org` resolves one exact Organization in this order: the saved
+read default, then the recovery handle this machine recorded for the person's
+Organization journey. A recovery handle can also name an Organization whose
+setup lane still runs, which the own-access list does not carry yet; the read
+reports that exact lane, and it applies the usual current-access rule again once
+the Organization reports ready. The read refuses an Organization it cannot
+reach, and it never substitutes another one.
+
 `org use` requires an explicit Organization ID. It checks current access and
 saves a protected per-person read default. The default never grants authority.
 Each read checks current access again. Without an explicit ID or saved default,
@@ -60,12 +113,74 @@ No match returns exit 2. Duplicate matches return exit 1.
 seconds and defaults to 120. Timeout returns exit 5; interruption returns 130.
 A successful read can report a failed or pending domain state.
 
+## Invitation commands
+
+```sh
+capxul org invite list [--mine] [--limit N] [--cursor C] [--phase PHASE ...] [--org O]
+capxul org invite get --invitation-id I [--org O]
+capxul org invite wait --invitation-id I [--org O] [--timeout-seconds N]
+capxul org invite review --invitation-id I --org O [--timeout-seconds N]
+capxul org invite accept --invitation-id I --offer-digest D --org O [--confirm] [--timeout-seconds N]
+capxul org invite decline --invitation-id I --org O [--confirm]
+capxul org invite cancel --invitation-id I --org O [--confirm]
+capxul org invite resend --invitation-id I --org O [--confirm]
+capxul org invite retry --invitation-id I --org O [--confirm]
+capxul org member invite (--to-email E | --account-id ID) [--budget-id B ...] [--permission-id M ...] [--new-budget-name N --asset A (--limit Q | --unlimited) (--recipient-account ID ... | --any-recipient) --actions pay[,commitments]] --org O [--request-key K] [--preview] [--confirm]
+```
+
+`org invite list` returns your own offers. It accepts `--limit` (1--100),
+`--cursor`, and repeated `--phase` values, and its result carries `invitations`,
+`nextCursor`, and `observedAt`: pass `nextCursor` back as `--cursor`, and change
+no other filter between the two calls. `--mine` names the own-offer projection,
+which is already the default. With `--org O` the command returns that
+Organization's invitations for a current Admin instead; the Organization list is
+not filtered to you, so `--mine` together with `--org` refuses with exit 2. The
+other invitation commands require an exact `--invitation-id`.
+
+`org invite get` and `org invite wait` use `--org` when you name it. Without
+`--org` they walk your own-offer pages, 100 rows per request, until they find
+the invitation or the pages end. They never consult the saved read default, and
+an offer you cannot see is refused. `--timeout-seconds` bounds the resolution
+and the read together on both commands.
+
+`org invite wait` only reads. It finishes when the offer settles or when the
+recovery asks a person to act. It never retries, resends, or accepts.
+
+`org invite review` requires `--org`, returns the current `InvitationView`
+directly in `data`, and performs no write or signing.
+
+The four transitions require `--org` in both modes, as `accept` does. They never
+author a new offer. A noninteractive or JSON run requires `--confirm`. An
+interactive run shows the resolved current offer and asks a default-no question.
+
+`org member invite` authorizes one exact offer. `--preview` writes nothing and
+needs neither a request key nor confirmation. A noninteractive write requires
+`--request-key` and `--confirm`. An interactive run prints the request key it
+used before it submits, so a lost response is recoverable with the same
+identity. At most one `--new-budget-name` is accepted per command.
+
+`org invite accept` is the exact grantee's consent commit. It takes the exact
+digest the offer shows as `--offer-digest`: a noninteractive or JSON run must
+supply it, and without it the command refuses with exit 2 before it creates a
+client. An interactive run may omit it, and then reads the offer and fills the
+digest from the value it displayed. A digest you state is never replaced by the
+displayed one. `--expected-offer` remains a compatibility spelling, and both
+spellings must match when supplied together. The command returns the
+`InvitationView` directly in `data`. The grant is executed by the deployment's
+technical executor, so the command needs no browser bridge and works in a
+headless or CI session. A repeat with the stored digest returns the same
+accepted result; a different digest refuses and cannot overwrite consent. The
+returned view is the authorization-time view of the consent commit
+(`pending_grant`); read the settled `active` state with `get` or `wait`.
+
 ## Organization writes
 
 `org create` and `org retry` restore the protected current session and start the
 existing command-scoped browser signer. They never read or write the saved read
-default. Local input checks run before any client, browser, or backend work, and
-they include the confirmation gate:
+default. `org create` writes the person's Organization recovery handle. That
+handle holds the exact business handle and the exact Organization ID, and it
+holds nothing else. Local input checks run before any client, browser, or
+backend work, and they include the confirmation gate:
 
 - A noninteractive or JSON write requires `--confirm`. Without it the command
   refuses with exit 2 before any client, browser, or mutation work.
@@ -106,6 +221,47 @@ failed lane still reports the Organization it is about. The command returns
 success only after an exact `org(O).getLifecycle()` read reports `ready`. It
 never saves a read default and never returns a different ready Organization.
 
+`org create` continues the Organization journey this machine already prepared.
+Before the first durable write it records the exact business handle as the safe
+recovery handle. It adds the first committed Organization ID to that handle
+before it forwards any founder authorization digest, and it keeps that handle
+after a failure, an interruption, or a ready result. A later create therefore
+resolves exactly one Organization:
+
+- The same handle resumes the exact recorded Organization. It calls the SDK
+  recovery owner once per attempt and settles the same lifecycle. It never
+  submits a second bootstrap, and it never creates a second Organization or
+  treasury.
+- A different handle refuses with exit 2 while the recorded Organization is not
+  ready. The refusal names the exact Organization.
+- A different handle creates one Organization only after the recorded
+  Organization reaches ready.
+- A recorded Organization that is already ready, and still in the person's
+  current access, returns unchanged, with no write and no signature. A ready
+  result the person can no longer reach refuses, and the committed recovery
+  handle stays recorded for exact recovery.
+- A create that continues a recorded handle checks current access before it
+  reports success. The committed Organization ID becomes durable first, so a
+  refusal or an interruption keeps the exact recovery handle, and a ready
+  lifecycle line reaches stderr only after the check resolves.
+- A terminal preview reads the recorded Organization's lifecycle only for the
+  handle that continues it. A different handle is a new creation, so an
+  unreachable recorded Organization never blocks it.
+- A handle the backend refuses is refused before any Organization write. The
+  command releases the prepared handle, so the person can correct the handle and
+  create. Every other failure keeps the handle, because its Organization may
+  already exist.
+
+The recovery line names the exact Organization and the safe handle. JSON mode
+writes it as one newline-delimited progress object:
+
+```json
+{ "type": "organization.recovery", "organizationId": "O", "handle": "acme" }
+```
+
+`org retry` stays explicit: `--org` (or its alias `--org-id`) is the one write
+scope, and no read default or recovery handle is consulted.
+
 `org retry` requires an explicit `--org` (or `--org-id`). It validates the ID
 with the public `toOrgId` constructor, reads that exact Organization's lifecycle
 for its terminal preview, resumes that same durable setup lane, then settles the
@@ -162,7 +318,8 @@ unsafe permissions, symlinks, and corrupt state produce a storage failure.
 
 ## Output
 
-`--json` writes one version 1 envelope to stdout. Success contains `data`.
+`--json` writes one version 1 envelope to stdout. Success contains `data`, which
+can be an object, array, or null according to the command's SDK result.
 Failure contains `error.code` and CLI-owned `error.message`. Each envelope has
 `command`, `invocationId`, and `outcome`. An invocation ID is null before a
 command starts. Human errors go to stderr.
@@ -242,11 +399,21 @@ stored and tagged as `legacy-native-grant` in status. A profile read asks for an
 explicit new login; it never exchanges the old grant for a broader session.
 Logout forgets and attempts to revoke both credential types for the selected email.
 
-For a human, `capxul auth login` prompts for email and a hidden OTP. `auth signup`
-also prompts for the current Profile fields: display name, two-letter country
-code, and handle. The browser opens only when the shared Core onboarding journey
-needs Openfort wallet readiness. It shows wallet status only. It has no email,
-OTP, Profile, or approval form.
+`capxul auth login` and `capxul auth signup` stay separate commands. On a
+terminal, each command is a wizard. `auth login` asks for the email and a masked
+OTP. It accepts the code as a paste. It retries an invalid code at most three
+times for one request. After sign-in, an incomplete account gets one offer to
+continue setup in the same command. `auth signup` authenticates first, then asks
+for the Profile fields: display name, two-letter country code, and handle. A
+known value is the prompt default, so Enter keeps it.
+
+The browser opens only when the shared Core onboarding journey needs Openfort
+wallet readiness. It shows wallet status only. It has no email, OTP, Profile, or
+approval form.
+
+Ctrl+C or Ctrl+D at a wizard prompt cancels the command. The command prints no
+success result and exits 130. A step that already finished keeps its result: a
+completed sign-in keeps its session.
 
 For an agent, send and verify in separate processes:
 
@@ -254,7 +421,6 @@ For an agent, send and verify in separate processes:
 capxul auth send --email "$TEST_EMAIL" --json
 # Supply the delivered six-digit OTP through stdin, not a command argument.
 capxul auth verify --email "$TEST_EMAIL" --otp-stdin --json
-capxul auth signup --email "$TEST_EMAIL" --display-name "Test Person" --country GH --handle test_person --json
 capxul auth profile --email "$TEST_EMAIL" --json
 # A later process uses the same protected CLI home; no new OTP is required.
 capxul auth profile --email "$TEST_EMAIL" --json
@@ -262,12 +428,13 @@ capxul auth status --email "$TEST_EMAIL" --json
 capxul auth logout --email "$TEST_EMAIL" --json
 ```
 
-`--otp-stdin` reads up to 64 bytes, ending at EOF. Pipe from a secret provider or
-use input redirection from a protected file. OTPs are never accepted in argv,
-persisted in the continuation, or included in output. Non-interactive commands
-without the required input refuse with exit 2 instead of prompting.
+A machine run never prompts. `auth login` with `--otp-stdin` sends the OTP and
+verifies one code from stdin. It returns the tagged result
+`setupState: "setup-required"` when the account needs setup. It does not start
+setup work, so sign-in never becomes signup.
 
-A fresh non-interactive signup can do verification and setup in one command:
+A fresh machine signup does verification and setup in one command. State every
+Profile field; a missing field refuses with exit 2:
 
 ```sh
 # Supply only the delivered OTP through stdin.
@@ -275,6 +442,11 @@ capxul auth signup --email "$TEST_EMAIL" --otp-stdin \
   --display-name "Test Person" --country GH --handle test_person --json
 ```
 
+`--otp-stdin` reads up to 64 bytes, ending at EOF. Pipe from a secret provider or
+use input redirection from a protected file. An invalid value refuses with exit 2. A missing `--otp-stdin` refuses with exit 2 before the command starts client
+work. OTPs are never accepted in argv, persisted in the continuation, or included
+in output.
+
 The local page binds to an OS-selected loopback port. A random launch capability
 is redeemed once and removed from the URL before Openfort starts. The page receives
 only the authenticated wallet token and encryption session in memory. Closing it
@@ -282,6 +454,29 @@ ends the current wallet attempt. Re-run `auth signup` with the same CLI home to
 resume the same Profile and Account without another OTP while the backend session
 remains valid.
 
+`auth signup` returns only two readiness results. `setupState: "ready"` is a
+personal Account that the Account readiness owner reads as ready and deployed,
+and its data carries the public identifiers: the Profile, the public wallet
+address (`smartAccount.signerAddress`), the personal Smart Account address
+(`smartAccount.smartAccountAddress`), the Account ID
+(`lifecycle.accountId`), and the ready status. Any other state returns the typed
+recoverable result `setupState: "setup-required"`, with the lifecycle, its
+failure code, and the command that resumes the journey. A ready Account starts
+no wallet work, so a retry keeps the one Profile, wallet, Smart Account, and
+Account. An interruption keeps the stored session and stores no code, so the
+next command resumes the same setup.
+
+A ready personal Account continues the same journey into Organization creation
+with `capxul org create --name NAME --handle HANDLE --country CC`. The create
+command records the safe recovery handle for that Organization, so an
+interruption or a restart resumes the exact same Organization.
+
+The CLI checks `--display-name`, `--country`, and `--handle` before it opens a
+client, so a malformed value refuses with exit 2 and no code is sent. The handle
+check covers the grammar only: a handle that another person holds, and a reserved
+handle, refuse through the identity owner after sign-in. Both refusals name the
+handle, and neither offers verification-code recovery for a Profile problem.
+
 The version 2 `first-party-session` record stores the opaque provider credential
 in the existing protected plaintext store. Its scope includes the application
 key, issuer, environment, and email. Each process validates restoration with the