# Quickstart (/docs)

Okae assesses pull requests and identifies changes that need human review. It combines mandatory rules with model assessment and explains the result on GitHub. Okae doesn't merge pull requests.

## Current availability [#current-availability]

Hosted access is currently arranged with the Okae team. Installing the GitHub App alone doesn't activate processing.

The dashboard supports real GitHub sign-in, organisation-owner checks, installation access and repository lists through Okae's management API. Public dashboard hosting and verification of the hosted sign-in and installation flow are still pending.

The connected dashboard reads effective default-branch settings, their sources, approval blockers and credit balances. Settings editing, check history, purchases and starter-credit redemption remain **Coming soon**. A separate fixture preview uses sample data and simulated sign-in to demonstrate planned features. Preview actions don't change your GitHub installation or activate processing.

Contact [hello@okae.ai](mailto:hello@okae.ai) to confirm access and repository-data terms before connecting a repository. Self-service purchases and public agent connectors are planned.

In the dashboard, choose **Getting started** to select a repository and prepare its policy
with your coding agent. Agent setup is recommended; manual configuration is available too.
You can leave the guide and resume it later, including through the return link in the
agent instructions. Verify your first completed assessment directly on GitHub.

## Connect your first repository [#connect-your-first-repository]

1. Confirm with Okae which GitHub organisation and repository you'll use. You need an organisation owner to install the App or approve the installation request.
2. [Install the Okae GitHub App](https://github.com/apps/okae-ai/installations/new). Choose **Only select repositories** and select the agreed repository. Review the permissions GitHub displays.
3. Add `okae.yml` at the root of the branch your pull requests will target. Start with approvals disabled:

```yaml title="okae.yml"
enable_approvals: false
max_changed_lines: 500
max_files: 10
strictness: standard
protected_paths: []
```

4. Have a person review and merge the configuration. Okae reads configuration from each PR's base branch, so the configuration PR cannot change its own policy.
5. Open an agreed small PR, or push a commit to an existing open PR. Look for the **Assess changes** check and the Okae comment.

Choose protected paths that reflect your repository before relying on the policy. Your [coding agent can help prepare the file](/docs/agents).

## Verify the result [#verify-the-result]

A routine result means the change passed Okae's assessment. A human-review result explains why someone should look at it. An error means processing couldn't complete; inspect its details before relying on the result.

With `enable_approvals: false`, Okae runs in shadow mode and doesn't submit approval reviews. Keep your existing branch protections and review process while evaluating results.

To enable approval reviews later, review [approval mode](/docs/configuration#approval-mode) and agree the change with your team. A green check alone doesn't establish that an approval review was submitted.

## Next steps [#next-steps]

- [GitHub connection](/docs/github): permissions, repository selection and removal.
- [Configuration](/docs/configuration): supported settings, defaults and limits.
- [Troubleshooting](/docs/troubleshooting): missing results, access and configuration errors.