Skip to content

Getting Started

The current MVP path is optimized for a local-first setup:

  1. install dependencies
  2. initialize your config
  3. bootstrap the selected profile
  4. start the runtime and orchestrator services
  • Node.js >=22.12.0
  • npm
  • access to any provider credentials referenced by your config.toml

From the repository root:

Terminal window
npm install
npm run orq:init -- --profile local
npm run orq:bootstrap
npm run dev

In a second terminal, start the orchestrator for the current repository:

Terminal window
npm run dev:orchestrator -- --repo-root "$PWD"

If you install Orqestrate globally, the primary commands are:

Terminal window
orq init
orq bootstrap
orq runtime start
orq orchestrator start --repo-root "$PWD"

The current operating model uses:

  • Linear as the planning surface
  • Notion as the durable artifact surface
  • a local runtime daemon for execution and persistence
  • an orchestrator service to claim work and advance ticket phases
Terminal window
npm run check
npm run site:dev
npm run site:build
npm run site:check

For more detailed bootstrap and contributor guidance, see the repo-local docs in docs/guides/ and docs/contributor_workflow.md.