Getting Started
The current MVP path is optimized for a local-first setup:
- install dependencies
- initialize your config
- bootstrap the selected profile
- start the runtime and orchestrator services
Prerequisites
Section titled “Prerequisites”- Node.js
>=22.12.0 - npm
- access to any provider credentials referenced by your
config.toml
Local quickstart
Section titled “Local quickstart”From the repository root:
npm installnpm run orq:init -- --profile localnpm run orq:bootstrapnpm run devIn a second terminal, start the orchestrator for the current repository:
npm run dev:orchestrator -- --repo-root "$PWD"Installed package path
Section titled “Installed package path”If you install Orqestrate globally, the primary commands are:
orq initorq bootstraporq runtime startorq orchestrator start --repo-root "$PWD"What happens next
Section titled “What happens next”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
Useful repo commands
Section titled “Useful repo commands”npm run checknpm run site:devnpm run site:buildnpm run site:checkFor more detailed bootstrap and contributor guidance, see the repo-local docs in docs/guides/ and docs/contributor_workflow.md.