Quick Start

Install dependencies, configure models, and launch the desktop app locally.

Use this page as the minimal setup checklist for a local development workspace.

Prerequisites

  • Node.js 18+
  • pnpm 8+
  • A desktop OS with microphone access for voice features
  • Model provider credentials for dialogue and task execution

Install Dependencies

Install workspace dependencies from the repository root:

pnpm install

If the workspace uses local speech or embedding assets, download them before launching the desktop app:

pnpm download:models

Configure Environment

Create an environment file for the desktop app and fill in provider details:

cp apps/desktop/.env.example apps/desktop/.env

Common variables:

VariablePurpose
LLM_*Dialogue model configuration.
TASK_*Task execution model configuration.
ASR_*Speech recognition provider configuration.
TTS_*Speech output provider configuration.
PROXY_URLOptional HTTP/HTTPS proxy.

Launch Desktop

During development, launch the Electron desktop app from the repository root:

pnpm desktop:dev

For a production-style local launch:

pnpm start

Next Steps

On this page