pagers

Getting started

Install

Pick whichever fits your machine — all of them produce the same two binaries, pagers and pagers-mcp.

From a clone

git clone https://github.com/hieudoanm/pagers
cd pagers
./scripts/install-local.sh

Builds the release binaries and installs them into ~/.local/bin (override with PREFIX=/path). Requires a Rust toolchain.

From anywhere, via curl

curl -fsSL https://raw.githubusercontent.com/hieudoanm/pagers/main/scripts/install.sh | sh

Downloads the source, builds it, and installs the binaries — same result as the local script. See Scripts for PAGERS_REF, PAGERS_REPO and PREFIX options.

With Cargo

cargo install --path crates/pagers-cli   # pagers
cargo install --path crates/pagers-mcp   # pagers-mcp

Scaffold a site

pagers init my-site

Creates my-site/docs/ with an index page and an example article.

Build it

pagers build my-site/docs
# or explicitly:
pagers build my-site/docs --output my-site/dist

The directory layout is the configuration:

my-site/docs/
├── index.md           → /
├── guide/
│   ├── index.md       → /guide/
│   └── install.md     → /guide/install/
└── assets/logo.png    → copied through as an asset

Open dist/index.html in a browser, or run pagers serve my-site/docs to build and serve it on localhost:8080.

What's next