Skip to content

Quick start

Get a working local copy of the scaffold in under five minutes.

Prerequisites

  • Node.js ≥ 22 (use nvm or fnm)
  • npm ≥ 10
  • git, gh (GitHub CLI) — gh is required for the Inceptor sub-agent workflow

Run npm run doctor at any time to verify your environment.

Clone & install

gh repo create my-thing --template ArtemioPadilla/inceptor --public --clone
cd my-thing
npm install

Run the dev server

npm run dev

Visit http://localhost:4321/ for the app, http://localhost:4321/docs/ for these docs.

The 5-second tour

CommandWhat it does
npm run devAstro dev server with HMR
npm run buildProduction build (static + service worker)
npm run checkAll gates: type-check + Astro check + tests + build
npm run testVitest unit tests
npm run test:visualPlaywright visual regression
npm run mondayMonday-morning dashboard
npm run shipPush current branch + open PR
npm run doctorPreflight environment check
npm run docsOpen the docs INDEX

Next

Read What you get for the feature inventory, or The 60-second Inceptor tour to understand the workflow before you make your first change.

Report an issue

Show diagnostics

Environment

 

Console errors

 

Failed requests