Quickstart

Install RepoDocs AI in under 5 minutes.

Clone the repository, install dependencies, validate the documentation system, and start from the templates, prompts, and examples. This page is the shortest path from first visit to usable system.

Prerequisites

What you need first

  • Node.js 20 or later
  • npm
  • Git
  • Docker Desktop if you want the hosted control-plane path

Install Flow

The core setup is only three commands.

git clone https://github.com/SulagnaSasmal/repodocs-ai.git
cd repodocs-ai
npm install
npm run validate

After Install

Bootstrap your own docs repo

If your goal is to adopt RepoDocs AI into a real product documentation repository, create a docs repo and copy the starter assets. 

mkdir company-docs
cd company-docs
cp -R ../repodocs-ai/templates .
cp -R ../repodocs-ai/prompts .
cp -R ../repodocs-ai/diagrams .

Or from the RepoDocs AI repository root: 

npm run bootstrap:docs-repo -- ../company-docs
  • Start with templates/api/ for API documentation
  • Use templates/features/ for feature and workflow docs
  • Use templates/governance/ for review and QA guidance
  • Use prompts/ to draft and review content with AI
Open docs hub View source install guide Read system guide View example system

Optional Runtime Check

Verify the hosted automation runtime locally

If you want to test the Redis-backed control plane, set a bootstrap key and run the one-command stack smoke test. 

$env:REPODOCS_CONTROL_PLANE_BOOTSTRAP_KEY = 'replace-me'
npm run control-plane:stack:smoke

Source Document

The installation guide also ships as source Markdown.

The repository source for this page lives at docs/installation.md, and the published source copy is available at site/docs/installation.md.