Quickstart

1. Run the server#

You need Go 1.26 or newer. One binary, one SQLite file.

git clone https://github.com/emb715/roadmap && cd roadmap
go run ./cmd/roadmap

The server listens on http://127.0.0.1:8080 and keeps everything in roadmap.db in the current directory. Delete that file to start over.

To run it on a server, with TLS and backups, use Docker Compose instead. See Deployment.

2. Create your account#

In a second terminal:

go run ./cmd/roadmap admin create --email you@example.com --name 'Your Name'

It prints a one-time setup link. Open it and choose a password. You are the first administrator, and you invite everyone else from Settings → Accounts.

Want to look around a tracker that is already full? Seed a throwaway database with demo projects, issues and accounts, and serve it on another port:

go run ./cmd/roadmap demo seed --db demo.db --addr 127.0.0.1:8081
go run ./cmd/roadmap --db demo.db --addr 127.0.0.1:8081

3. Create an agent token#

Open Settings → Access tokens and create a token. Name it after the machine or agent that will use it, such as claude-laptop: every change the agent makes is shown with that name. The token starts with rmp_ and is shown once.

4. Connect your agent#

For Claude Code:

claude mcp add --transport http roadmap http://127.0.0.1:8080/mcp \
  --header "Authorization: Bearer rmp_..."

Then ask it to “list the projects in Roadmap”. For Cursor, Claude Desktop and other clients, see Connect an agent.