Upload Builds
Upload Android APK and iOS IPA builds with real-time progress and automatic email notification to testers.
The buildshare upload command uploads an Android APK or iOS IPA package to BuildShare, displaying real-time upload progress and automatically sending installation notifications to your team and testers over email upon completion.
Mandatory Authentication & Project ID
Uploads without a project are disabled (the legacy anonymous upload endpoint /builds/upload has been removed). All uploads require authentication and a projectId, which is read automatically from buildshare.json / buildshare.yaml or provided explicitly via --app <projectId>.
Usage
# Platform-based upload (using buildshare.json / buildshare.yaml)
buildshare upload <android|ios> [flags]
# Direct file upload
buildshare upload <file-path> [flags]1. Platform-Based Upload
When your project is configured with a buildshare.json or .buildshare.yaml file (via buildshare init), you don't need to specify full file paths. The CLI automatically locates the binary in the configured platform path:
# Automatically finds the APK in androidPath and uploads
buildshare upload android
# Automatically finds the IPA in iosPath and uploads
buildshare upload ios
# With release notes
buildshare upload android --notes "Sprint 42 test build"2. Direct File Upload
Direct file upload is supported for both Android (.apk) and iOS (.ipa) files. If you are outside a configured project directory, specify the target project ID with --app <projectId>:
# Direct APK upload with explicit project ID
buildshare upload ./app-release.apk --app <projectId>
# Direct IPA upload with release notes
buildshare upload ./app-release.ipa --app <projectId> --notes "Sprint 42 test build"Config Precedence
If a buildshare.json or buildshare.yaml exists in the current or any parent directory, buildshare upload <file> will read the projectId from that file automatically unless overridden with --app <projectId>.
Examples
Upload your platform build using paths defined in buildshare.json:
buildshare upload android --notes "Automated release build"Flags & Options
| Flag | Short | Description |
|---|---|---|
--app <projectId> | — | Explicit project ID (overrides configuration file) |
-c, --config <path> | -c | Path to custom configuration file (.json or .yaml) |
--notes <text> | — | Release notes or change description for this build (alias for --changelog) |
--changelog <text> | — | Release notes or change description for this build |
--ci | — | Run in non-interactive CI mode (suppresses prompts, spinners, and ANSI colors) |
--json | — | Output result as structured JSON instead of human-readable text |
--verbose | -v | Enable detailed debug logging for request/response traces |
Real-Time Progress & Terminal Output
When running in an interactive terminal, the CLI renders an animated progress indicator with elapsed transfer speed and estimated completion time:
Uploading app-release.apk [========================>---] 82% (42.5 MB / 51.8 MB) 4.2 MB/sUpon a successful upload, the CLI prints the build confirmation (an installation email is automatically dispatched to testers):
✔ Upload completed successfully!
Build ID: bld_982348a7b
App ID: com.example.myapp
Version: 1.4.0 (42)
Size: 51.8 MBStructured JSON Mode
When passing --json, output is formatted as JSON, making it easy to parse from bash, Python, or CI/CD step outputs:
{
"status": "success",
"build": {
"id": "bld_982348a7b",
"app_id": "com.example.myapp",
"app_name": "My App",
"platform": "android",
"version_name": "1.4.0",
"version_code": "42",
"file_size": 54316234,
"created_at": "2026-03-20T14:32:00Z"
}
}