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

# Quickstart

> Sign in, land on your project, then connect a repository.

Sign in, land on your default project, then connect a repository. That is the whole setup.

## Prerequisites

* Node.js 20.9 or later
* A clone of the Ruminate repository
* Clerk keys configured for local auth (see [Environment](/environment))

## Run the app

<Steps>
  <Step title="Install dependencies">
    ```bash theme={null}
    npm install
    ```
  </Step>

  <Step title="Start the app">
    ```bash theme={null}
    npm run dev
    ```
  </Step>

  <Step title="Sign in">
    Open the app in your browser. The marketing page is at `/`. Sign in — you land on **Untitled project**, which you can rename in Settings.
  </Step>
</Steps>

<Tip>
  Connect a GitHub repository from **Connect a project** when you are ready for real analysis.
</Tip>

## What to look at first

Start on the project **Overview**, then pick one of these:

* **Knowledge** — what the project understands, grounded in real files
* **Architecture** — systems and how they connect
* **Activity** — when the project's understanding last changed

When you want your own repository, see [Connect a repository](/connect).

## Useful commands

| Command                                 | What it does                              |
| --------------------------------------- | ----------------------------------------- |
| `npm run dev`                           | Run the app                               |
| `npm run refresh [id]`                  | Re-read structure without re-interpreting |
| `npm run mcp`                           | Run the MCP server over stdio             |
| `npm run analyze github <owner> <repo>` | Analyse a repository from the terminal    |