Development

Development

git clone https://github.com/scortes5/agentboard.git
cd agentboard
npm install        # dependencies + node-pty permission fix
npm start          # run in development mode
npm run check      # which agent CLIs are installed
npm run app        # build and install the app
npm run dist:mac   # .dmg files      ·  npm run dist:win  → .exe
npm run icon       # regenerate icons from src/assets/logo.svg
npm run test:e2e   # open the real app and drive a task with a fake agent
npm run test:smoke # open the app, run a command in a real terminal, open every panel (CI: macOS and Windows)
xvfb-run -a node scripts/demo/record-demo.js   # re-record docs/images/demo.gif (Linux, needs Pillow)
xvfb-run -a -s "-screen 0 1700x1200x24" node scripts/demo/screenshots.js   # retake docs/images/*.png

Checks

CI (.github/workflows/ci.yml) runs on every push and pull request:

npm ci --ignore-scripts
git ls-files '*.js' | xargs -n1 node --check

The e2e job opens the real app under xvfb and runs test/e2e.js (see Architecture → Tests).

CodeQL code scanning (GitHub default setup) analyzes JavaScript and workflows on every push and pull request. Dependabot opens weekly update PRs for npm packages and GitHub Actions.

Releasing

1. Bump version in package.json (and VERSION in scripts/agentboard-mcp.js): new features raise the middle number (1.4.2 → 1.5.0), fixes and small changes the last one (1.4.2 → 1.4.3), and a milestone with many features the first one (1.9.0 → 2.0.0).
2. Move Unreleased entries in CHANGELOG.md under the new version.
3. Merge to main. The build workflow notices that vX.Y.Z has no tag yet, builds the macOS and Windows installers and publishes the Release (creating the tag) with generated notes.

Pushes to main that keep the same version do not build anything. Pushing a v* tag by hand still works.

Editing this wiki

Pages live in wiki/. The wiki workflow publishes them to the GitHub Wiki on every push to main. File names become page titles (Quick-Start.md → Quick Start); link between pages with [[Page Name]].

See also: CONTRIBUTING.md · Architecture