> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usekyoto.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub

> Run Kyoto in GitHub Actions.

Run Kyoto in GitHub Actions to get vibe checks on your pull requests — ensuring your project's vibes are always on point.

<Tabs>
  <Tab title="Auto Setup">
    Run the command below to setup the GitHub actions

    ```sh theme={null}
    kyoto setup github
    ```
  </Tab>

  <Tab title="Manual Setup">
    Create a GitHub Actions workflow at `.github/workflows/kyoto.yml`

    ```yml .github/workflows/kyoto.yml theme={null}
    name: Kyoto

    on:
      push:
        branches:
          - main
      pull_request:

    jobs:
      test:
        runs-on: ubuntu-latest
        permissions:
          checks: write
          contents: read
        env:
          KYOTO_TOKEN: ${{ secrets.KYOTO_TOKEN }}
        steps:
          - uses: actions/checkout@v4
          - uses: actions/setup-node@v4
            with:
              node-version: '22'
          - run: npx @usekyoto/cli vibe check
    ```
  </Tab>
</Tabs>

## GitHub Actions Secrets

Kyoto requires the `KYOTO_TOKEN` secret to run in GitHub Actions.

1. Go to your repository on [GitHub](https://github.com/)
2. Navigate to **Settings** → **Secrets and variables** → **Actions**
3. Click **"New repository secret"**
4. Name: `KYOTO_TOKEN`
5. Call `kyoto setup github` to view the token value.