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 users

Description

Opens an interactive TUI for the current organization. Lists every member with their role and project count, lets you expand a member to see their per-project roles and protected-branch grants, and lets you change anything from the keyboard. If stdout isn’t a TTY (e.g., piped to a file), Capy falls back to a static rendering of the same table.

Example

  Organization Members (3 users)

  Email                          Role           Added         Projects
  ─────────────────────────────────────────────────────────────────────
> alice@acme.com                 owner          2025-01-15    2 projects
  bob@acme.com                   member         2025-02-03    1 project
  carol@acme.com                 admin          2025-03-10    2 projects
  ─────────────────────────────────────────────────────────────────────
   ↑↓ navigate  Enter expand/collapse  r change role  g grant protected  q quit

Expanding a row

Pressing Enter on a row expands it to show that member’s project roles and the protected branches they have grants on:
> alice@acme.com                 owner          2025-01-15    2 projects
    api-backend          admin
      main               (org-wide)
      production         (granted)
    web-frontend         member
      main               (org-wide)
      production         (no access)
(org-wide) branches need no grant - anyone in the org can read them. (granted) and (no access) only appear on protected branches.

Changing a role

Pressing r on a member or project row inline-edits the role with an arrow-key picker. Selections apply on Enter:
> bob@acme.com                   ❯ admin                      1 project
                                   project-admin
                                   member
                                   remove
   ↑↓ pick role  Enter confirm  Esc cancel
Picking remove from the org-level role picker has the same effect as capy kick <email>. Picking remove from a per-project picker only revokes that project’s role; the member stays in the org.

Granting a protected branch

Move the cursor onto a (no access) branch row and press g. The status flips to (granted). Press g again to revoke. Same operation as the non-interactive capy grant-branch / capy revoke-branch commands.

Keys

KeyWhat it does
/ Move the cursor
EnterExpand or collapse the row under the cursor
rChange the role for the selected row (member or per-project)
gToggle a protected-branch grant for the selected branch row
EscCancel the current edit
q or Ctrl-CQuit

Non-interactive use

Pipe the command and Capy writes a static rendering with no footer hints:
capy users | tee members.txt
The static output is the same table, no cursor, no prompts. Useful in CI to snapshot org state.