Development

Developer Setup and Contributing

Check out and build

git clone https://github.com/Varun-SV/Cascade-AI.git
cd Cascade-AI
npm install
npm run build
npm test
npm run lint

The root package.json requires Node.js 22.22.2+. The monorepo uses TypeScript, Vite, tsup, Vitest and npm workspaces.

Path / workspace	Responsibility
src/	Published core SDK, CLI and orchestration engine
app/	Desktop Electron + React app
cloud/server/	Cloud Express backend and shared run pipeline
cloud/web/	Cloud React frontend
web/	Local dashboard
docs/	Internal design/reference documents in the codebase; not the GitHub Wiki publishing target

Useful development commands

Command	Purpose
npm run build	Build CLI/SDK and local dashboard
npm run build:app	Build Electron application
npm run dev:app	Launch desktop development environment
npm run dev:cloud	Launch cloud server in development
npm run dev:cloud-web	Launch cloud frontend development
npm test	Root Vitest test suite
npm run lint	TypeScript checks
npm run build -w cascade-cloud-server	Build cloud server workspace

For frontend end-to-end tests, see cloud/web/e2e/ and its Playwright configuration.

Contribution expectations

1. Base changes on main; keep each change focused.
2. Add regression tests for bug fixes.
3. Run relevant tests, checks and builds before submitting.
4. Update CHANGELOG.md with user-facing changes. Follow repository versioning guidance for SDK/CLI/desktop vs cloud-only changes.
5. Document behavior accurately, including failures, security boundaries and unsupported surfaces.

Wiki maintenance is separate

The public GitHub Wiki is managed as its own set of Markdown pages through user-managed uploads/edits. Wiki updates are not merged into docs/wiki on the main repository and must not require a documentation PR. See Documentation-Maintenance.

Source: CONTRIBUTING.md and CI workflows.