> ## 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.

# Quick Start

> Getting started with Kyoto

```sh theme={null}
入   |
京   |
行   |  Kyoto • May the vibe be with you.
改   |
善   |
```

<p align="center">
  <sub>
    `入` Enter `京` Kyoto `行` to take action towards `改 善` continuous
    improvement.
  </sub>
</p>

We are crafting **Kyoto** to be the missing vibe coding tool. Today, we offer

* `vibe check` that runs several agents focused on fixing AI-generated slop
  and preventing entropy in your codebase so you can remain productive with vibe coding.
* `vibe test` which reviews the changed files for frontend changes and runs a browser
  to test the changed automatically.

<Info>
  Kyoto comes with **\$5/month** of free llm credits. [Contact
  us](https://x.com/iopeak) if you exceed that limit.
</Info>

Get started quickly with Kyoto simply by installing the CLI and logging in.

<Steps>
  <Step title="Install">
    <CodeGroup>
      ```sh npm theme={null}
      npm install -g @usekyoto/cli
      ```

      ```sh bun theme={null}
      bun install -g @usekyoto/cli
      ```

      ```sh pnpm theme={null}
      pnpm install -g @usekyoto/cli
      ```
    </CodeGroup>
  </Step>

  <Step title="Login">
    From within your git repository, log in to Kyoto via:

    ```sh theme={null}
    kyoto login
    ```
  </Step>

  <Step title="Vibe">
    You are ready to vibe check your code.

    ```sh theme={null}
    kyoto vibe check
    ```
  </Step>
</Steps>

<p align="center">
  <span style={{ color: '#b30000' }}>入 京 行 改 善</span>
</p>

Kyoto is [**open source**](https://github.com/stevepeak/kyoto) led by [Steve Peak](https://x.com/iopeak) (Founder of [Codecov](https://codecov.io)).

Inspired and initially demoed at [**Hacker Residency Group**](https://www.hackerresidencygroup.com/) in Da Nang, Vietnam 2025.

<CardGroup cols={2}>
  <Card title="Bug reports & feature requests" href="https://github.com/stevepeak/kyoto/issues">
    Open an issue on GitHub.
  </Card>

  <Card title="Stay in the loop" href="https://x.com/iopeak">
    Follow @iopeak on X.
  </Card>
</CardGroup>