Skip to content

Development setup

Node 22 is recommended, Node 20 is the documented minimum, and Node 18 is unsupported — for both the free and Pro repositories.

Clone and install

bash
git clone https://github.com/crossainthero-lab/AgentDock.git
cd AgentDock
npm ci
npm run dev

AgentDock Pro is developed from a separate, private repository (crossainthero-lab/AgentDock-Pro) using the same commands — do not substitute the public clone when working on Pro-only features.

Warning

Always install with plain npm ci (or npm install). Installing with NODE_ENV=production, npm ci --omit=dev, or any configuration that skips devDependencies will leave electron-vite missing and npm run dev unable to start.

Node version

Node 22 is recommended and used in CI; Node 20 is the documented minimum supported major. Node 18 is not a supported development environment.

Required checks before opening a PR

bash
npm run typecheck
npm test
npm run build

Use the relevant real-Electron smoke script (see Testing strategy) for changes touching agent execution, IPC, persisted workflow state, packaging, or destructive actions — these are exactly the categories unit mocks can't prove.

Related