GitHub App
Install the KekoHQ app so threads can clone, push, open pull requests and hear about checks and reviews
Keko works with GitHub through the KekoHQ GitHub App. You sign in to Keko with GitHub; installing the app is a separate step that gives threads access to the repositories you pick.
Install it
In the Mac app, open Settings → Accounts and choose Connect GitHub. Your browser opens GitHub's install page.
Pick the account or organization, then all repositories or the ones threads may use, and install.
GitHub sends you back to a page that says "Connected to" your account. Back to Keko returns to the app, where Settings → Accounts lists each installation with its repositories.
Installing from GitHub's own pages, at github.com/apps/kekohq, works too. To change the repositories later,
use Manage on GitHub next to the installation.
What threads can do with it
- Read with your own GitHub access: a thread sees what you can see.
- Push and open pull requests with your own access, where GitHub says you can push. Commits and pull requests are yours; GitHub shows them as made through the app. Nothing is added to commit messages.
- Post reviews and comments as the app's bot,
kekohq[bot], with access to that one repository only.
A thread can't reach a repository you can't see yourself, even if your organization installed the app on it.
Permissions it asks for
| Access | What for |
|---|---|
| Contents, read and write | Cloning, and pushing branches |
| Pull requests, read and write | Opening pull requests, reviews and comments |
| Issues, read and write | Comments on pull requests |
| Workflows, read and write | Pushing changes to GitHub Actions workflows |
| Checks, statuses, actions, read | Telling a thread how its checks went |
| Metadata and email, read | Your account and repository names |
What GitHub tells a thread
The app hears about pushes, pull requests, reviews, comments and checks on the repositories it's installed on, and passes them to the thread that owns the pull request:
- Checks: the sidebar row says Checks, PR failing or PR ready. A failed run sends the thread the failing checks and the end of their logs, once per commit, and wakes it if it's idle.
- Reviews and comments from people on GitHub arrive as their messages, with a link. While the thread is working they're queued; otherwise they wait for you to send them on, and the thread needs you until you do.
- Merged or closed pull requests update the thread.
Where it's used
On Keko Cloud, a thread on a GitHub repository is cloned and pushed through the app, private repositories included. On
This Mac and your servers, git uses the device's own GitHub sign-in first and the app only when GitHub refuses it (see
Your server); the copy is kept in ~/.keko/projects for the next thread.
When the app isn't installed on a private repository that needs it, the thread says so.
Remove it
Uninstall the app, or remove repositories from it, in GitHub's settings under Applications → Installed GitHub Apps, or with Manage on GitHub. Keko loses access to those repositories at once.