bon-voyage-cli
v2.0.3
Published
CLI for Bon Voyage — a multi-tenant mobile build orchestration and distribution platform
Maintainers
Readme
bon-voyage-cli
Command-line interface for Sloss — a multi-tenant mobile build orchestration and distribution platform for Expo apps.
Install
npm install -g bon-voyage-cliQuick Start
# 1. Log in (saves credentials + picks default project)
bv login
# 2. Submit a build
bv build --platform ios --profile development
# 3. Watch the logs
bv logs <build-id>Setup
1. Create a Sloss account
Sign up at your team's Sloss instance (e.g. https://bonvoyagebuild.com/signup). After signing up, you'll receive an API key on the onboarding page.
2. Authenticate the CLI
bv loginThis prompts for email and password, fetches your API key and JWT, lists your projects, and saves everything to ~/.config/sloss/credentials.json.
Alternatively, set these environment variables:
SLOSS_API_KEY— your API keySLOSS_PROJECT— default project IDSLOSS_URL— server URL (defaults tohttps://bonvoyagebuild.com)
3. Set a default project
If you have multiple projects, set a default so you don't need --project on every command:
sloss projects list
sloss projects use <project-id>Commands
Builds
bv build # Submit a build (uses default project)
bv build --platform android # Android build
bv build --profile production # Production profile
bv build --bump minor # Version bump type for production
sloss list # List recent builds
sloss list --limit 20 # List more
sloss info <build-id> # Build details
bv logs <build-id> # Stream live build logs
sloss retry <build-id> # Retry a failed/cancelled build
sloss cancel <build-id> # Cancel a queued/running build
sloss delete <build-id> # Delete a buildProjects
sloss projects list # List your projects
sloss projects show <project-id> # Project details
sloss projects use <project-id> # Set default project
sloss projects delete <project-id> # Delete a projectDevices
sloss devices list # List registered devices
sloss devices register <udid> # Register a device by UDID
sloss devices register <udid> --name "iPhone 15"
sloss devices remove <device-id> # Remove a deviceUpload
Upload a pre-built IPA or APK directly:
sloss upload ./build/App.ipa --platform ios --profile preview
sloss upload ./build/app.apk --platform androidOther
sloss init # Quick setup (login + project selection)
bv login # Authenticate and save credentialsAuthentication
Credentials are stored in ~/.config/sloss/credentials.json after bv login. This includes:
- API key — used for build operations (list, submit, retry, cancel, upload)
- JWT token — used for project and device management
- Default project ID — used when
--projectis not specified
Resolution order (highest → lowest priority):
| Setting | Flag | Env Var | credentials.json |
|---------|------|---------|-----------------|
| API Key | --api-key | SLOSS_API_KEY | apiKey |
| Server URL | --url | SLOSS_URL | url |
| Project | --project | SLOSS_PROJECT | projectId |
Global Options
| Flag | Description |
|------|-------------|
| --api-key <key> | Override API key |
| --url <url> | Override server URL |
| --project <id> | Override project ID |
| --json | Output as JSON |
| --version | Show CLI version |
| --help | Show help |
How It Works
bv buildsubmits a build job to the Sloss server with your project ID- A build agent (connected via WebSocket) picks up the job
- The agent runs
eas build --localon the project's cloned repo - The finished IPA/APK is uploaded back to Sloss
- You get a build page with install links and QR codes
Build agents are managed per-project on the server. Projects are created via the Sloss web dashboard, which handles GitHub repo connection, agent provisioning, and credential configuration.
OpenClaw Skill
This package includes an OpenClaw skill. Add it to your config:
// ~/.openclaw/openclaw.json
{
skills: {
load: {
extraDirs: ["./node_modules/bon-voyage-cli/skills"]
}
}
}Related
- Sloss Server — The build orchestration server
License
MIT
