Skip to content

CLI Commands

Main Commands

commoners

Run your project in development mode.

commoners build

Build the project assets.

  • --outDir [path] - The output directory for the build (string)

Desktop Builds

  • --publish [condition] - Publish a release of your application to GitHub on the provided condition (string)
    • Note: While other providers are possible to use, they have not been tested with this command.
Mac
  • --sign - Enable code signing (--target desktop on Mac only). Will be automatically enabled with --publish

Service Selection

  • --service [name] - Build a specific service. Can use multiple times. (string)

commoners launch

Launch your built application.

  • [path] - The output directory of the build to launch (string)

Shared Options

Target Platform (commoners / build / launch)

Specify the target platform for the command.

  • --target [target]
    • web - Default option
      • pwa - As a Progressive Web App (build only)
    • desktop - For your current desktop platform (boolean/ string)
      • electron - Build with Electron
      • tauri - Build with Tauri (TBD)
    • mobile - For the mobile platform corresponding to your build enviroment
      • ios - For iOS (ios only)
      • android - For Android

Released under the MIT License.