When this guide is complete, Rudder Desktop is open on your machine and the rudder CLI is ready for later starts. You need a supported desktop system, a terminal, internet access for the first download, and permission to install an app for your user account.

Install and open Rudder

Run the public setup command:
The command prepares the persistent Rudder CLI, downloads the portable Desktop app for the selected release channel, and opens it. It keeps the CLI and app on the same release. Rudder CLI terminal workflow After setup, start the same local app directly:
The setup succeeds when the Desktop window reaches Rudder’s organization screen. You can now create your first organization.

If Desktop cannot start

A healthy startup shows the Rudder identity and motion. It does not expose technical stage names or percentage progress. A quiet waiting screen during startup is normal. If the managed local server reports a startup failure, the same window shows a plain-language error and recovery actions:
  • Try again starts one fresh attempt in the existing window. Repeated clicks do not start parallel runtimes or open more windows.
  • Email support opens an editable draft addressed to zeeland4work@gmail.com. Rudder does not send it, upload local data, or attach workspace files automatically. If the mail app cannot open, use Copy support email and Copy diagnostic.
  • Report on GitHub opens Rudder’s fixed public GitHub Issues bug-report form. Rudder never submits the issue. If the browser cannot open, use Copy issue link, open that fixed URL yourself, then use Copy diagnostic and review the text before pasting it.
  • Technical details reveals only bounded, allowlisted fields and paths. Copy diagnostic copies the same safe diagnostic used by the support actions. Open data folder opens the failed instance folder when a path is available; if the folder cannot open automatically, copy the visible Instance folder path and open it in your file manager.
Read the technical details before sharing them. Do not add credentials, databases, .env files, or private workspace contents to a support request.

If an update finds active runs

Packaged Rudder Desktop can download and verify an update while Agent Runs are active. Choose based on whether the current work may be interrupted:
  • Update when idle keeps current runs alive and applies the update after they finish.
  • Stop runs and update now cancels active runs, quits Rudder, and applies the update immediately.
  • Cancel leaves the current version running.
If an update fails or expires, the failure remains visible with retry and release-page actions.

Create Your First Organization

Complete one task and inspect its result.