# CLI reference Every `cafe` command, grouped by area. Run `cafe --help` for all of a command's options. To install the CLI and sign in, see [install the CLI](https://staging.git.cafe/docs/getting-started/cli.md). ## Global options | Option | Effect | | --------------------------------- | ---------------------------------------------------- | | `--repo ` | Repository to act on (default: the current clone) | | `--host ` | GitCafe API address (default `https://git.cafe/api`) | | `--json` | Print structured JSON on stdout | | `--format pretty\|markdown\|json` | Choose the output format | | `--yes` | Confirm destructive actions without asking | | `--no-input` | Fail instead of prompting | | `--no-browser` | Never open a browser | | `--no-update-check` | Do not check for a newer release | | Environment variable | Effect | | ---------------------- | ------------------------------------------ | | `CAFE_HOST` | Same as `--host` | | `CAFE_REPO` | Same as `--repo` | | `CAFE_TOKEN` | A token to use instead of the stored login | | `CAFE_NO_UPDATE_CHECK` | Same as `--no-update-check` | ## Authentication | Command | Does | | ---------------------------------------------------- | ---------------------------------------------------------------------------------- | | `cafe auth login` | Sign in through the browser ([device sign-in](https://staging.git.cafe/docs/account/device-authorization.md)) | | `cafe auth status` | Show who you are signed in as | | `cafe auth logout` | Remove the stored login (`--all` for every server) | | `cafe auth http setup` | Let Git use your login for HTTPS remotes | | `cafe auth http status` | Check the Git credential setup | | `cafe auth ssh setup` | Find and register your SSH key, optionally set up signing | | `cafe auth ssh list\|add\|remove` | Manage SSH authentication keys | | `cafe auth setup` | Configure HTTPS and SSH in one step, without prompts | | `cafe auth token list\|create\|view\|rotate\|revoke` | Manage [personal access tokens](https://staging.git.cafe/docs/account/personal-access-tokens.md) | | `cafe signing ssh list\|add\|remove` | Manage SSH signing keys | | `cafe signing gpg list\|add\|remove` | Manage [GPG keys](https://staging.git.cafe/docs/account/gpg-keys.md) | Managing tokens and keys needs the optional credential-management permission when you sign in. ## Repositories | Command | Does | | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------ | | `cafe repo list` | List repositories you can access | | `cafe repo create ` | Create a repository (`--private`, `--org`, `--clone`) | | `cafe repo view [owner/name]` | Show a repository | | `cafe repo clone [dir]` | Clone a repository | | `cafe repo edit` | Change description, topics, visibility, default branch | | `cafe repo fork [owner/name]` | Fork a repository | | `cafe repo sync` | Update a fork's default branch from its parent | | `cafe repo compare-upstream` | Show how far a fork is ahead or behind | | `cafe repo forks` | List a repository's forks | | `cafe repo transfer ` | Transfer a repository | | `cafe repo delete ` | Delete a repository | | `cafe repo star\|unstar\|stargazers\|starred` | Manage and list stars | | `cafe repo archive ` | Write a tar.gz snapshot to stdout | | `cafe repo collaborator list\|add\|remove` | Manage [collaborators](https://staging.git.cafe/docs/repositories/repository-access.md) | | `cafe repo ruleset list\|view\|create\|edit\|delete` | Manage [rulesets](https://staging.git.cafe/docs/repositories/repository-rulesets.md) (`--org`, `--team` for inherited ones) | | `cafe repo ruleset effective ` | Show the rules that apply to a branch | | `cafe repo branch-role list\|assign\|revoke` | Manage per-branch roles | ### Code | Command | Does | | --------------------------------------- | --------------------------------------------- | | `cafe repo code tree [path]` | List files | | `cafe repo code blob ` | Print a file (`--raw` for the bytes) | | `cafe repo code commits` | List commits | | `cafe repo code commit ` | Show a commit and its diff | | `cafe repo code compare ..` | Compare two revisions (`--patch`) | | `cafe repo code refs` | List branches and tags | | `cafe repo code search ` | [Search code](https://staging.git.cafe/docs/repositories/code-search.md) | | `cafe repo code status ` | Show a commit's combined check status | ### Branches and tags | Command | Does | | -------------------------------------------- | -------------------------------------------- | | `cafe branch list` | List branches (`--deleted` for deleted ones) | | `cafe branch delete ` | Delete a branch | | `cafe branch restore ` | Restore a deleted branch | | `cafe tag list` | List tags | | `cafe tag view ` | Show a tag | | `cafe tag delete ` | Delete a tag | | `cafe repo ref-deletion list\|view\|inspect` | Check the result of branch and tag deletions | ## Pull requests | Command | Does | | ---------------------------------------- | ------------------------------------------------------------------------------------- | | `cafe pr list` | List pull requests (`--state`) | | `cafe pr create` | [Open a pull request](https://staging.git.cafe/docs/pull-requests/open.md) from the current branch | | `cafe pr view ` | Show a pull request | | `cafe pr checkout ` | Check out a pull request's branch | | `cafe pr edit ` | Change the title, description or target (`--base`) | | `cafe pr diff ` | List changed files (`--patch`, `--path`) | | `cafe pr commits ` | List the commits | | `cafe pr status [number]` | Show reviews, checks and mergeability | | `cafe pr ready ` | Check merge readiness against rulesets | | `cafe pr merge ` | [Merge](https://staging.git.cafe/docs/pull-requests/merge.md) (`--strategy merge\|squash\|rebase\|fast-forward`) | | `cafe pr close ` | Close without merging | | `cafe pr review ` | Submit a review (`--approve`, `--request-changes`, `--comment`) | | `cafe pr reviews ` | List reviews | | `cafe pr review-view\|review-dismiss` | Show or dismiss a review | | `cafe pr reviewer list\|add\|remove` | Manage requested reviewers | | `cafe pr comments ` | List comments | | `cafe pr comment ` | Comment, or comment on a line with `--path` and `--line` | | `cafe pr comment-edit\|comment-delete` | Edit or delete a comment | | `cafe pr resolve\|unresolve` | Resolve or reopen a review thread | | `cafe pr milestone [milestone]` | Set or clear the milestone | | `cafe pr lock\|unlock ` | Lock or unlock the conversation | | `cafe pr links\|link\|unlink` | Manage linked issues | ## Stacks See [stacked pull requests](https://staging.git.cafe/docs/pull-requests/stacks.md). | Command | Does | | -------------------------- | -------------------------------------------------------------------------------- | | `cafe stack submit` | Push local commits as a stack of pull requests (`--name`, `--base`, `--dry-run`) | | `cafe stack link ` | Link existing pull requests into a stack, bottom first | | `cafe stack list` | List stacks | | `cafe stack status [pull]` | Show the stack containing a pull request | | `cafe stack merge [pull]` | Land the stack up to a pull request (`--stack` for all) | | `cafe stack restack` | Rebase the stack onto its updated base | | `cafe stack close [pull]` | Close the stack and its open pull requests | ## Issues and milestones | Command | Does | | ---------------------------------------------------------------- | ----------------------------------------------------- | | `cafe issue list` | List issues (`--state`, `--label`, `--assignee`) | | `cafe issue create` | Create an issue | | `cafe issue view ` | Show an issue | | `cafe issue edit ` | Change title, body, state, priority or due date | | `cafe issue close ` | Close an issue as completed | | `cafe issue comments\|comment` | List or add comments | | `cafe issue comment-edit\|comment-delete` | Edit or delete a comment | | `cafe issue assign\|unassign` | Manage assignees | | `cafe issue label list\|create\|edit\|delete` | Manage the repository's [labels](https://staging.git.cafe/docs/issues/labels.md) | | `cafe issue label add\|remove` | Label or unlabel an issue | | `cafe issue milestone [milestone]` | Set or clear the milestone | | `cafe issue pin\|unpin` | [Pin](https://staging.git.cafe/docs/issues/pin-and-lock.md) an issue | | `cafe issue lock\|unlock` | Lock or unlock the conversation | | `cafe issue links\|link\|unlink` | Manage linked pull requests | | `cafe milestone list\|view\|create\|edit\|close\|reopen\|delete` | Manage [milestones](https://staging.git.cafe/docs/issues/milestones.md) | ## CI | Command | Does | | --------------------------------------------------------- | -------------------------------------------------------- | | `cafe ci list` | List runs (`--pr`, `--branch`, `--commit`) | | `cafe ci view ` | Show a run | | `cafe ci status` | Show runs for a pull request, branch or the latest | | `cafe ci watch ` | Wait until a run finishes | | `cafe ci jobs ` | List a run's jobs | | `cafe ci logs --job ` | Print or save a job log (`--full`, `--tail`, `--output`) | | `cafe ci binding list\|view\|create\|edit\|delete` | Connect pipelines to a repository | | `cafe integration list\|view\|create\|edit\|delete ` | Manage [Buildkite integrations](https://staging.git.cafe/docs/ci/buildkite.md) | ## Webhooks The target is an organization slug or `owner/repo`. See [webhooks](https://staging.git.cafe/docs/integrations/webhooks.md). | Command | Does | | ------------------------------------------------- | ------------------------------------ | | `cafe webhook list\|view ` | List or show webhooks | | `cafe webhook create\|edit\|delete ` | Manage webhooks | | `cafe webhook rotate-secret ` | Replace the signing secret | | `cafe webhook ping ` | Send a signed test ping | | `cafe webhook capabilities\|readiness` | Check supported events and readiness | | `cafe webhook deliveries\|dead-letter\|attempts` | Inspect delivery history | | `cafe webhook redeliver ` | Send a failed event again | ## Organizations and teams | Command | Does | | ------------------------------------------------------------ | ---------------------------------------------------------- | | `cafe org list\|view\|create\|edit\|delete` | Manage [organizations](https://staging.git.cafe/docs/organizations/organizations.md) | | `cafe org member list\|set\|remove ` | Manage [members](https://staging.git.cafe/docs/organizations/organization-members.md) | | `cafe org invitation list\|create\|delete ` | Manage invitations | | `cafe org invitation accept ` | Accept an invitation | | `cafe team list\|create\|view\|edit\|reparent\|delete ` | Manage [teams](https://staging.git.cafe/docs/organizations/teams.md) | | `cafe team member list\|set\|remove ` | Manage team members | | `cafe team repos ` | List a team's repositories | | `cafe team repo create ` | Create a repository for a team | ## Profile | Command | Does | | ---------------------------- | ------------------------------------------ | | `cafe profile view [handle]` | Show a public profile | | `cafe profile edit` | Edit your [profile](https://staging.git.cafe/docs/account/profile.md) | | `cafe profile pins` | List your pinned repositories | | `cafe profile pin ` | Replace your pinned repositories | ## Other commands | Command | Does | | ----------------------------------- | ------------------------------------------- | | `cafe api ` | Send an authenticated [API](https://staging.git.cafe/docs/reference/api.md) request | | `cafe config get\|set\|unset\|list` | Read and write settings such as `stack.vcs` | | `cafe skills list\|show\|install` | Install `cafe` skills for coding agents | | `cafe completion ` | Print a shell completion script | | `cafe version` | Show the version (`--check` for the latest) |