All documentation

Documentation Settings: Account

Account: GitHub, API keys and other apps

Connect GitHub for runs and pull-request reviews, mint API keys for your own code, and link Telegram or Discord.

The Connected card holds everything outside the apps that acts as you. On the Mac most rows say Set up on the web ↗, because the links are made in a browser.

GitHub

A token for each run that has a GitHub remote, in your name, limited to the repositories you choose. The sandbox keeps your own GitHub sign-in away from seats; this gives each run a short-lived token instead.

Where to find it. Web: Settings → Account → Connected → GitHub for the Mac app's runs. Mac: the same row links to the web. Shown only when the server has a GitHub app configured.

How to use it.

  1. Press Connect GitHub → and approve at GitHub.
  2. Press Choose repositories → to limit which repositories it covers.
  3. Pick When a run ends: Leave the token to expire (default; it lasts about eight hours) or End the token at once.

When not to use it. If seats never push or open pull requests, leave it unconnected. Disconnect removes it.

Pull-request reviews on GitHub

Install the app on a repository and each pull request gets a summary comment, inline comments and a check in the merge box. Reviews run on the server and are paid from your account credit, not from a CLI seat. The app never approves, never runs code and never writes to the repository.

Where to find it. Mac: Settings → Account → Account → Connected. Web: the same card. iPhone: Settings → Account → GitHub Reviews.

SettingDefaultWhat it does
Review pull requests, When a pull request is opened, On every later push, On @mention commands, Reply under a command, Inline comments on the diff, Resolve our threads once fixed, Remember settled findings, EconomyOnWhen reviews happen and what they post
Pull requests from forksOffReviews pull requests from forks too
Repository lookups per review8 (0–20)How much surrounding code a review may read
Cost limit per reviewOne dollar (0 = none)Stops one review spending more
Reviews a day50A daily cap per installation
Only these repositoriesEmpty (all)owner/name, one per line

On a busy repository, keep Economy on and lower the cost limit. Unlink and Settled findings are on the web.

Web: Settings → Account → Connected → Pull-request reviews on GitHub, one installation's switches
Web: Settings → Account → Connected → Pull-request reviews on GitHub, one installation's switches

API keys

Spend this account's credit from your own code through an OpenAI-compatible endpoint at /api/v1/chat/completions. Pro and Team only; on Free, existing keys keep working while the plan does.

How to use it.

  1. Type what the key is for and press New key.
  2. Copy it now. It is shown once.
  3. Revoke ends a key. Up to ten live at a time.

Calls are charged at model cost. Free Key models are not served here. On iPhone: Settings → Account → API Keys.

Telegram and Discord

Talk to the room from a Telegram chat or a Discord direct message. Both are set up on the web under Connected. For Telegram, make a bot, paste its token, press Connect, then open the link once. For Discord, paste the bot token, copy the Interactions Endpoint URL into Discord's developer portal, add the bot, and send the /link command shown. Disconnect ends either. Slack and Microsoft Teams are team integrations.

Further reading.

See also

Not what you were looking for? The help centre answers one question at a time, and the support page says how to reach a person.