CLI reference
Install or update:
dotnet tool install --global DotCarbon.Clidotnet tool update --global DotCarbon.CliDevelopment and generation
Section titled “Development and generation”| Command | Purpose |
|---|---|
carbon dev [desktop] |
Run Vite and the watched desktop host |
carbon dev android |
Build and deploy to Android |
carbon dev ios |
Build and run on a booted iOS simulator |
carbon types |
Generate carbon.d.ts and sync app capabilities |
carbon icon |
Generate desktop and mobile icon assets |
Common options include --project <directory>. carbon types accepts --out and
--no-capabilities; carbon icon accepts --input and --output.
Dependencies
Section titled “Dependencies”carbon add nuget <package> [--version <version>]carbon add plugin <alias-or-package> [plugin metadata options]Known plugin aliases wire backend, frontend, registration, and permissions. Third-party plugin options
include --class, --using, --namespace, --npm, and repeated --command values.
Platforms
Section titled “Platforms”carbon platform add <desktop|android|ios>carbon platform sync <desktop|android|ios> [--force]carbon platform listCapabilities
Section titled “Capabilities”carbon capabilities listcarbon capabilities add <permission> [--capability main] [--window main]carbon capabilities synccarbon capabilities checkcarbon capability is an alias for carbon capabilities.
Desktop production
Section titled “Desktop production”carbon build [--target <rid>] [--aot] [--bundle] [--updater-artifacts]carbon bundle desktop [--target <rid>] [--aot] [--no-package] [--updater-artifacts] [--dry-run] [--verify]Without a subcommand, carbon bundle bundles the current desktop target.
Android production
Section titled “Android production”carbon bundle android [--apk | --aab] [--debug | --release] [--dry-run] [--allow-unsupported-plugins]APK and Release are the defaults.
iOS production
Section titled “iOS production”carbon bundle ios [--simulator | --device | --archive] [--dry-run] [--allow-unsupported-plugins]Simulator is the default.
Diagnostics and signing
Section titled “Diagnostics and signing”carbon doctorcarbon doctor signingcarbon signer generate --output <private-key-path>Use carbon <command> --help for the exact options supported by the installed version.
