Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.capy.sc/llms.txt

Use this file to discover all available pages before exploring further.

​
Synopsis

capy invite <email>

​
Description

Generates a one-time redeem code that grants <email> access to the current organization. Capy prompts you for a role (Member, Project Admin, or Admin) and offers to copy the code to your clipboard. The recipient runs capy redeem <code> to complete the flow.

​
The redeem code

The code is a base64 string containing the invite token T, the organization ID, and an outer-wrapped copy of the master key. Deliver it out-of-band (Signal, a password manager share, a QR code, a phone call) - anyone who intercepts it plus the separately-held service wrap could recover the master key. Email and Slack DMs are not acceptable channels. See Inviting users for why.

​
Example

$ capy invite alice@example.com
? What role should alice@example.com have? Member
✔ Invite created.

Redeem code (copied to clipboard):
  CAPY-INV-k3n4...ZxYw

Share this code with alice@example.com over a channel you trust.
The code is one-time — it can only be used once.

​
See also