# Quickstart

> Set up gspot yourself or with your coding agent.

Set up gspot yourself, or give one prompt to your coding agent.

## Set up gspot

* Human

  Run these commands in the root of your repository.

  * npm

    ```shell
    npm i -D -E @gspothq/cli
    npx gspot init
    npx gspot install
    ```

  * pnpm

    ```shell
    pnpm add -D -E @gspothq/cli
    pnpm exec gspot init
    pnpm exec gspot install
    ```

  * Yarn

    ```shell
    yarn add -D -E @gspothq/cli
    yarn exec gspot init
    yarn exec gspot install
    ```

  * Bun

    ```shell
    bun add -d -E @gspothq/cli
    bunx gspot init
    bunx gspot install
    ```

  * mise

    ```shell
    mise use --pin node@24 --tool-option allow_low_downloads=true npm:@gspothq/cli
    mise exec -- gspot init
    mise exec -- gspot install
    ```

  1. The first command adds gspot to the project, pinned to one version.
  2. `gspot init` shows a plan. When you accept it, gspot writes `gspot.toml`, the tool files, `AGENTS.md` and the rules, the Git hooks, and the CI workflow, and deletes the tool files it replaces. [Read the plan](/start/migrate/#read-the-plan) first.
  3. `gspot install` installs the pinned tools and turns on the hooks. From then on, every commit runs the checks.

  gspot starts at level `recommended`. For stricter checks, run `gspot set level all`, then `gspot install` again. [Levels](/start/concepts/#levels) says what each level checks.

* Agent

  ```shell
  npm i -D -E @gspothq/cli
  npx gspot init
  npx gspot install
  ```

* npm

  ```shell
  pnpm add -D -E @gspothq/cli
  pnpm exec gspot init
  pnpm exec gspot install
  ```

* pnpm

  ```shell
  yarn add -D -E @gspothq/cli
  yarn exec gspot init
  yarn exec gspot install
  ```

* Yarn

  ```shell
  bun add -d -E @gspothq/cli
  bunx gspot init
  bunx gspot install
  ```

* Bun

  ```shell
  mise use --pin node@24 --tool-option allow_low_downloads=true npm:@gspothq/cli
  mise exec -- gspot init
  mise exec -- gspot install
  ```

* mise

  Paste this prompt into Claude Code, Codex, Cursor, or another coding agent that can run commands.

  ```text
  Set up gspot in a repository. Run curl -fsSL https://generativespotting.com/llms.txt and follow its steps.
  ```

  The agent then:

  1. Adds `@gspothq/cli` with the package manager of your repository, or pins it with mise.
  2. Runs `gspot init --dry-run`, shows you the plan, and asks which [level](/start/concepts/#levels) you want. It writes the plan only after you agree.
  3. Runs `gspot install` and `gspot check`, and shows you the result.
  4. Reads `AGENTS.md` and the agent rules before it writes more code.

  Note

  Agents read the steps in [/llms.txt](/llms.txt). Read the whole documentation in [/llms-full.txt](/llms-full.txt).

## After you install

Commit `gspot.toml` and the files that gspot wrote; [Generated files](/reference/generated-files/) lists them. Then commit as usual. The pre-commit hook checks the staged files and stops the commit when a check fails. Run `gspot check` to check every file, including work that you did not commit.

## Next steps

* [Run checks](/use/run-checks/)
* [gspot.toml](/configure/gspot-toml/)
* [Coding agents](/use/coding-agents/)