Install

Install Reqbook CLI and API workflow notebook

Install Reqbook with the shell installer, npm, crates.io, Homebrew, Docker, Windows MSI, VS Code extension, or source checkout.

Install Reqbook Open full installation docs

Recommended install

The fastest path on macOS and Linux is the shell installer. It installs the rqb binary, then you can scaffold an API notebook and open the local browser workspace.

shell installer

$ curl -fsSL https://markapidown.net/install.sh | sh
$ rqb init --yes
$ rqb serve

Install channels

Shell installer

curl -fsSL https://markapidown.net/install.sh | sh

npm

npm install -g reqbook

crates.io

cargo install reqbook

Homebrew

brew install reqbook/tap/rqb

VS Code

code --install-extension reqbook.reqbook-vscode

Source checkout

cargo install --git https://github.com/ngoclinh93qt/ReqBook

Verify the API notebook workflow

After installation, create or import specs under api-docs/, validate the files, and run the local browser workspace.

$ rqb version
$ rqb doctor
$ rqb validate api-docs/
$ rqb exec api-docs/
$ rqb serve

If your team uses coding agents, run rqb skills install after the first specs are committed. See the FAQ or the Claude Code API testing guide.