This page is a work in progress and will be updated soon.
Installation
How to connect Keystone to your GitHub repositories
Prerequisites
- A GitHub account
- At least one repository you want to analyze
How to use Keystone
Keystone works in two ways. You can use either or both depending on your workflow:
| Dashboard | CLI | |
|---|---|---|
| Best for | Visual setup, monitoring ingestion, team management | Quick access, scripting, CI/CD integration |
| Connect repos | ||
| Agent chat | ||
| Monitor ingestion |
Dashboard
Keystone connects to your repositories through a GitHub App. This gives Keystone read access to your code, commits, and pull requests.
- Sign in to Keystone with your GitHub account
- Navigate to your organization dashboard
- Click Connect Repository and follow the GitHub App installation flow
- Select the repositories you want Keystone to analyze
Permissions
The Keystone GitHub App requires the following permissions:
| Permission | Access | Purpose |
|---|---|---|
| Repository contents | Read | Analyze code and commits |
| Pull requests | Read | Extract decisions from PR discussions |
| Metadata | Read | Repository information |
| Webhooks | Read & Write | Real-time updates on new pushes |
Initial ingestion
Once connected, Keystone begins processing your repository's commit history. Depending on the size of your repository, this may take a few minutes.
You can monitor the ingestion progress from your project dashboard.
CLI
Install the Keystone CLI globally:
npm install -g keystone
pnpm add -g keystone
yarn global add keystone
Once installed, authenticate with your account:
keystone login
For more details on CLI usage, see the CLI guide.
Next steps
- Follow the quick start guide to ask your first question