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

# Install Reqbook CLI and Desktop

> Install Reqbook on macOS, Linux, or Windows using the shell installer, Cargo, npm, Docker, Homebrew, or MSI.

## Requirements

Reqbook ships as a single static binary with no runtime dependencies: no Node, no Python, no JVM required.

| Install method  | Requirement                        |
| --------------- | ---------------------------------- |
| Shell installer | macOS or Linux, `curl`, `sh`       |
| Cargo           | Rust 1.75+                         |
| Homebrew        | macOS, [Homebrew](https://brew.sh) |
| npm             | Node.js 18+                        |
| Docker          | Docker Engine                      |
| Windows MSI     | Windows 10 / Server 2019 or later  |

***

## Install methods

<Tabs>
  <Tab title="Shell installer">
    Recommended for most macOS and Linux users. The installer fetches the latest prebuilt binary and places it in `~/.local/bin`.

    ```bash theme={null}
    curl -fsSL https://markapidown.net/install.sh | sh
    ```

    If `~/.local/bin` is not on your `PATH`, the installer prints the exact line to add to your shell profile (`~/.bashrc`, `~/.zshrc`, etc.).

    <Note>
      The shell installer script is open-source and auditable at [github.com/ngoclinh93qt/ReqBook](https://github.com/ngoclinh93qt/ReqBook/blob/main/scripts/install.sh).
    </Note>
  </Tab>

  <Tab title="Cargo">
    Install directly from [crates.io](https://crates.io/crates/reqbook). This builds Reqbook from source and places the binary in `~/.cargo/bin`.

    ```bash theme={null}
    cargo install reqbook
    ```

    Requires Rust 1.75 or later. Upgrade your toolchain with `rustup update stable` if needed.
  </Tab>

  <Tab title="Homebrew">
    Install via the official Reqbook tap on macOS (or Linux with Homebrew):

    ```bash theme={null}
    brew install reqbook/tap/rqb
    ```

    Homebrew manages upgrades via `brew upgrade rqb`. No separate tap add step is required; the formula URL handles it.
  </Tab>

  <Tab title="npm">
    Install via npm for Node.js projects. This bundles a prebuilt binary for macOS, Linux, and Windows; no Rust toolchain needed.

    ```bash theme={null}
    npm install -g reqbook
    ```

    The npm package is a thin wrapper around the native binary. You can also pin it as a `devDependency` to lock the version per project:

    ```bash theme={null}
    npm install --save-dev reqbook
    npx rqb validate api-docs/
    ```
  </Tab>

  <Tab title="Docker">
    Use the official image from GitHub Container Registry. Mount your project directory at `/work`:

    ```bash theme={null}
    docker pull ghcr.io/ngoclinh93qt/rqb:latest
    docker run --rm -v "$(pwd)":/work -w /work \
    ghcr.io/ngoclinh93qt/rqb:latest validate api-docs/
    ```

    Replace `validate api-docs/` with any `rqb` subcommand. To execute endpoints against a local server, use `--network=host` or Docker Compose.

    <Tip>
      Pin a specific version in CI to avoid unexpected behavior from `latest`: use a tag like `ghcr.io/ngoclinh93qt/rqb:0.2.5`.
    </Tip>
  </Tab>

  <Tab title="Windows (MSI)">
    Download the `.msi` installer from the [releases page](https://github.com/ngoclinh93qt/ReqBook/releases). Run the installer and `rqb` is added to your system PATH automatically; no manual PATH edits needed.

    <Note>
      Windows support is available from the current Reqbook release. The MSI installer targets Windows 10 and Windows Server 2019 or later.
    </Note>
  </Tab>
</Tabs>

***

## Verify the installation

After installing, confirm the binary is on your PATH and run the built-in diagnostics:

```bash theme={null}
rqb version
# 0.2.5

rqb doctor
```

<Note>
  `rqb doctor` runs a series of checks: it verifies that `api-docs/` exists, that local environment files are listed in `.gitignore`, that all specs in the project are valid, and that any installed AI agent skills match the current binary version.
</Note>

***

## VS Code extension

The VS Code extension uses the same `rqb` binary. Install Reqbook first, then configure the extension if VS Code cannot find `rqb` on its process `PATH`.

```json theme={null}
{
  "reqbook.rqbPath": "/absolute/path/to/rqb",
  "reqbook.env": "dev"
}
```

See the [VS Code extension guide](/guides/vscode-extension) for commands, variable autocomplete, and result panel behavior.

***

## Troubleshooting

### Shell installer returns 404

The shell installer downloads a platform-specific binary from the latest GitHub Release. For example, Apple Silicon macOS expects an asset named `rqb-aarch64-apple-darwin.tar.xz`.

If the install command fails with `curl: (56) The requested URL returned error: 404`, the latest release is missing that binary asset. Re-run the release workflow for the current tag or pin a release tag that has assets:

```bash theme={null}
curl -fsSL https://markapidown.net/install.sh | sh -s -- --version=vX.Y.Z
```

This is unrelated to starting an API server; it happens before `rqb` is installed.

***

## Shell completions

Generate and install completions for your shell so you get tab-completion for subcommands and flags:

<Tabs>
  <Tab title="Bash">
    ```bash theme={null}
    rqb completion bash >> ~/.bashrc
    source ~/.bashrc
    ```
  </Tab>

  <Tab title="Zsh">
    ```bash theme={null}
    rqb completion zsh > "${fpath[1]}/_rqb"
    # Restart your shell or run: exec zsh
    ```
  </Tab>

  <Tab title="Fish">
    ```bash theme={null}
    rqb completion fish > ~/.config/fish/completions/rqb.fish
    ```
  </Tab>
</Tabs>

***

## Upgrading

<Tabs>
  <Tab title="Shell installer">
    Re-run the installer it replaces the existing binary in place:

    ```bash theme={null}
    curl -fsSL https://markapidown.net/install.sh | sh
    ```
  </Tab>

  <Tab title="Cargo">
    ```bash theme={null}
    cargo install reqbook --force
    ```
  </Tab>

  <Tab title="Homebrew">
    ```bash theme={null}
    brew upgrade rqb
    ```
  </Tab>

  <Tab title="npm">
    ```bash theme={null}
    npm install -g reqbook
    ```
  </Tab>
</Tabs>

<Tip>
  After upgrading, run `rqb doctor --fix` to automatically update any installed AI agent skills (Claude Code, Cursor, Copilot) to the new version. Stale skill files can cause agents to call deprecated flags.
</Tip>