• English
  • API

    Rselectron exposes two stable surfaces that share one normalization and orchestration pipeline. The CLI is an adapter over the same programmatic operations — it does not maintain a second behavior implementation.

    SurfaceWhen to usePage
    Command Line InterfaceTerminal workflowsCommands and options
    JavaScript APIEmbed builds and development in tools or scriptsESM exports and lifecycle helpers

    Commands at a glance

    CommandPurpose
    rselectron devDevelopment session: build main / preload, serve renderer, launch Electron
    rselectron buildFinite production source build (no watch)
    rselectron previewBuild (unless --skip-build) and launch Electron against production outputs
    rselectron inspectPrint normalized configuration without building or launching

    There is no implicit default command. Running rselectron with no subcommand prints help to stderr and exits 1.

    Operational failures surface as RselectronError with a stable code. CLI exit codes and messages are projections of that error.

    Configuration is declared in rselectron.config.* — see Configuration for the process-key contract.