Getting Started

Install Neon Pilot from source and verify the setup.

Install from source

git clone <repo-url>
cd neon-pilot
pnpm install
pnpm run setup:hooks   # optional: enable the tracked pre-commit hook
pnpm run build

The repo intentionally has no first-party postinstall. Third-party build scripts are pinned in pnpm-workspace.yaml; review anything newly blocked with pnpm ignored-builds.

Start the desktop app

pnpm run desktop:start

The desktop app manages the local daemon automatically.

Important paths

• <state-root> — machine-local runtime state. Default: $XDG_STATE_HOME/neon-pilot when XDG_STATE_HOME is set, otherwise ~/.local/state/neon-pilot
• <config-root> — machine-local config. Default: $XDG_CONFIG_HOME/neon-pilot when set, otherwise <state-root>/config
• <vault-root> — durable knowledge root. See Configuration for override order and channel-specific state roots.

Verify the install

The desktop app starts and loads the conversation view. Create a new conversation and send a message to verify the agent responds.

Next steps

• Views — understand Conversation and Workbench layout modes
• Conversations — how to work with agent conversations
• Desktop App — Electron shell and shortcuts
• Knowledge — vault, skills, instruction files, and sync
• Configuration — config files and environment variables

Edit this page on GitHub →