CLI API Reference
Full reference for every jetstart command. For usage examples and workflows, see the individual command pages under CLI.
jetstart create
Scaffold a new Android/Compose project.
jetstart create <n> [options]
| Option | Type | Default | Description |
|---|---|---|---|
<n> | string | — | Project directory name |
-p, --package <n> | string | prompted | Android package name (com.example.app) |
-t, --template <n> | string | default | Project template |
--skip-install | boolean | false | Skip dependency checks |
--full-install | boolean | false | Non-interactive: auto-install all missing deps |
jetstart dev
Start the development server with hot reload.
jetstart dev [options]
| Option | Type | Default | Description |
|---|---|---|---|
-p, --port <port> | number | 8765 | HTTP server port |
-H, --host <host> | string | auto-detected LAN IP | Host for QR code and client connections |
--qr / --no-qr | boolean | true | Show QR code in terminal |
--open / --no-open | boolean | true | Open browser automatically |
--web | boolean | false | Auto-open web emulator in browser |
--emulator | boolean | false | Deploy to a running AVD on first build, then hot reload |
--avd <n> | string | — | Target a specific AVD by name (requires --emulator) |
Ports always used:
| Port | Service |
|---|---|
8765 | HTTP (REST API, APK download, web emulator redirect) |
8766 | WebSocket (device Γåö core real-time comms) |
8767 | Logs WebSocket server |
QR code format (compact pipe-separated):
host|port|wsPort|sessionId|token|projectName
jetstart build
Build an APK or AAB via Gradle.
jetstart build [options]
| Option | Type | Default | Description |
|---|---|---|---|
-o, --output <path> | string | ./build | Output directory |
-r, --release | boolean | false | Release build — R8, debuggable=false, dev credentials stripped from BuildConfig |
--sign | boolean | false | Sign with keystore.properties in project root |
--self-sign | boolean | false | Auto-generate a test keystore via keytool and sign |
--bundle | boolean | false | Build AAB instead of APK |
--flavor <n> | string | — | Build a specific product flavor |
keystore.properties format (required for --sign):
storeFile=path/to/release.jks
storePassword=your-store-password
keyAlias=your-key-alias
keyPassword=your-key-password
Release security hardening (applied automatically when --release is used):
- Dev-server URL and session token cleared from
BuildConfig build.gradlerestored to original content after build (even on failure)debuggable=falseenforced by the release Gradle variant- R8 minification and resource shrinking enabled
jetstart logs
Connect to the Logs server and stream device logs to the terminal.
jetstart logs [options]
| Option | Type | Default | Description |
|---|---|---|---|
-f, --follow | boolean | true | Stream live updates |
-l, --level <level> | string | all | Minimum log level: verbose, debug, info, warn, error, fatal |
-s, --source <source> | string | all | Filter by source: cli, core, client, build, network, system |
-n, --lines <n> | number | 100 | Historical lines to replay on connect |
Connects to ws://localhost:8767. Requires jetstart dev to be running.
jetstart install-audit
Check the development environment for all required dependencies.
jetstart install-audit [options]
| Option | Type | Default | Description |
|---|---|---|---|
--json | boolean | false | Output results as JSON (for CI/CD) |
Checks performed:
- Node.js ≥ 18.0.0
- npm ≥ 9.0.0
- Java/JDK ≥ 17.0.0
- Gradle ≥ 8.0.0
ANDROID_HOME/ANDROID_SDK_ROOTset and valid- Android SDK components:
platform-tools,build-tools,platforms;android-34 KOTLIN_HOME(for hot reload pipeline)
jetstart android-emulator
Interactive AVD manager — no subcommands or flags.
jetstart android-emulator
Opens a menu to:
- List existing AVDs with running/stopped status
- Start / stop an AVD
- Create a JetStart-optimized AVD (Pixel 7, API 34, x86_64, 2 GB RAM)
- Create a custom AVD (choose device, API level, ABI)
- Delete an AVD
jetstart clean
Remove build artifacts and caches.
jetstart clean
No options.
Global Options
These flags work with all commands:
| Flag | Description |
|---|---|
--version / -v | Print JetStart version |
--help / -h | Show help for the command |
Environment Variables
| Variable | Used by | Description |
|---|---|---|
ANDROID_HOME / ANDROID_SDK_ROOT | build, dev, install-audit | Android SDK path |
KOTLIN_HOME | dev (hot reload) | Path to kotlinc installation |
JAVA_HOME | build, dev | JDK path (passed to Gradle) |
DEBUG | all | Enable verbose debug logging |
JETSTART_PORT | dev | Default HTTP port override |
JETSTART_HOST | dev | Default host override |
Exit Codes
| Code | Meaning |
|---|---|
0 | Success |
1 | General error (invalid project, build failure, etc.) |
2 | Invalid arguments |