Skip to main content
Send a workspace invitation to an email address. The recipient receives a sign-in link that grants them access to the workspace currently active in ~/.config/gavai/credentials.json. This page covers the synopsis, the scope of the invite, and the exit codes the command returns.

Synopsis

gavai invite

Arguments

None positional. The recipient email is passed via a flag — see below.

Flags

The exact flag for the recipient email (and any role / scope flags) is the source of truth on the CLI itself. Run gavai invite --help for the authoritative list.

Behavior

The command is workspace-scoped: it always operates on the workspace named in active_workspace. To invite someone to a different workspace, switch the active workspace first — list candidates with gavai tenant, then re-run gavai login if you need to change which workspace the credentials are bound to. The recipient receives an email with a one-time sign-in link. The invitation remains valid until they accept it or you revoke it from the console.

Examples

Inspect the flag set:
gavai invite --help
Confirm which workspace the invite would land in before sending:
gavai whoami

Exit codes

See CLI overview — exit codes for the full table.