Getting started

Install Neondeck, run the guided setup, and open the local dashboard. You need Node.js 26 or newer and credentials for at least one supported model provider.

1. Install Node.js

Install Node.js 26 or newer using any installer or version manager, then confirm the active version:

node --version

2. Install Neondeck

Neondeck currently publishes beta releases on npm's next channel.

npm install --global neondeck@next

3. Run the setup wizard

neondeck init

The wizard creates your local runtime home, configures a model provider, checks the Git identity used for Autopilot commits, and can add repositories, choose a dashboard preset, and create initial schedules. It supports KiloCode, OpenAI, Anthropic, a ChatGPT subscription, and OpenAI-compatible endpoints such as OpenRouter. If global user.name or user.email is missing, the wizard warns and offers to configure both plus user.useConfigOnly so Git cannot silently invent an identity from the machine account. Complete author and committer overrides in the runtime-home .env are accepted, but temporary shell exports do not suppress this warning.

By default, local state is stored in ~/.config/neondeck. See Configuration for runtime-home, credentials, provider, and model details.

GitHub token for pull request workflows

Neondeck reads GITHUB_TOKEN from the runtime-home .env; it does not reuse the credential shown by gh auth status. For complete private-repository PR review and CI context, use a classic personal access token with the repo scope. If your organization uses SAML SSO, authorize the token for that organization, and confirm that the organization permits classic PAT access.

4. Start Neondeck

Start Neondeck and open the dashboard:

neondeck open

When no login service is installed, the server stays attached to this terminal. Press Ctrl-C to stop it.

On macOS and Linux, you can instead install a managed background login service:

neondeck service install
neondeck open

Use neondeck serve when you want the foreground server without opening a browser.

5. Open a companion-display window

Run open again to open another dashboard without changing the already-running server.

New runtime homes include named sidebar and xeneon window profiles for companion displays:

neondeck open sidebar --browser "/path/to/chromium"
neondeck open xeneon --browser "/path/to/chromium"

Profile names and window settings come from dashboard.json. Neondeck opens the OS default browser. To apply size, position, or kiosk settings, pass a Chromium-family executable with --browser <path>. See the Dashboard guide for browser app installation, display layouts, and window behavior.

6. Check the installation

neondeck status

Once the dashboard is running, use the CLI reference to add repositories, configure watches, inspect authentication, and run diagnostics.

When a newer release is available, Neondeck links to the upgrade guide from its dashboard banner.

Development

Working from a source checkout? See the development guide on GitHub for repository setup, npm scripts, tests, builds, packaging, and docs development.