Skip to content

Getting Started

Jump to bottom
Kuray Karaaslan edited this page Oct 5, 2026 · 1 revision

Getting Started

Requirements

  • Node.js >= 24
  • pnpm >= 10
  • Windows 11 is the primary tested desktop target

The product repo uses pnpm workspaces and Turborepo. The desktop app is Electron-based, with React and strict TypeScript.

Install

From the product repo:

pnpm install --frozen-lockfile

Run The Full Gate

pnpm exec turbo run typecheck lint test build

This is the main local quality gate. It runs the package-level checks that CI expects to stay green.

Launch The App

pnpm dev

If a raw Electron process opens without a GUI, check whether your shell has ELECTRON_RUN_AS_NODE=1. The repo's pnpm dev path clears this for the app.

Use The Agent

Open Settings and add your own AI provider key. Cloud keys are encrypted through the OS keychain and stay in the main process. Do not put provider keys in .env, fixtures, commits, screenshots, or logs.

The current model gateway supports multiple provider families and local-model seams, but exact model ids can change as the code evolves. See AI and Model Gateway.

Common Commands

Command Purpose
pnpm dev Run the desktop app in development
pnpm build Build all workspaces through Turbo
pnpm typecheck TypeScript checks
pnpm lint ESLint
pnpm test Unit/integration tests
pnpm coverage Coverage gate
pnpm depcruise Module boundary and import-cycle checks
pnpm e2e Playwright Electron smoke against the built app
pnpm run docs:links Relative documentation link check

Sources

  • README.md
  • CONTRIBUTING.md
  • apps/desktop/README.md
  • package.json

Clone this wiki locally