Skip to main content

Development

Setup

Node.js 20.19+ (or 22 LTS) is required for npm install / npm run dev (Vite 8).

git clone https://github.com/sergeychernov/ide-agents.git
cd ide-agents
npm install

Scripts

CommandDescription
npm run devBackend :3921 + Vite :5173
npm run buildCompile server + web
npm startRun production build
npm run docs:installInstall Docusaurus dependencies (first time)
npm run docs:startDocusaurus dev server
npm run docs:buildBuild documentation site
npm run lintESLint (src/, web/, template/**/*.mjs)
npm run lint:fixESLint with autofix
npm testVitest (web + server)
npm run test:webUI / install logic tests
npm run test:serverBackend apply/installations tests

Project structure

See Architecture for module overview.

Backend (src/)

TypeScript, ESM (NodeNext), compiled to dist/. Entry: dist/cli.js, bin: ide-agents.

Web (web/)

Vite + React + Mantine. Built to web/dist/, served by Fastify in production.

Docs (docs/)

Separate npm package (Docusaurus 3). Not bundled into the CLI.

Manual testing

Use any local git repo with skills/*/SKILL.md and/or agents/*.md. In the UI, add a file:// URL (see Source repositories).

CLI flags

ide-agents --port 3922 # preferred port (falls back to next free if busy)
ide-agents --no-open # do not open browser

Contributing guidelines

  • TypeScript strict-ish in src/
  • Minimal diffs; match existing patterns
  • API errors as { error: string }
  • macOS/Linux only for v0.1
  • Do not commit secrets or corp-specific skills