Quick Start
The typical workflow from authentication to your first mobile build upload and app management.
Get up and running with the BuildShare CLI in four simple steps.
Step 1 — Authenticate
Run the login command to authenticate your machine. In interactive terminals, it prompts for your BuildShare email and password:
buildshare loginAlternatively, supply an API token inline or via the BUILDSHARE_TOKEN environment variable:
BUILDSHARE_TOKEN=<your-token> buildshare loginStep 2 — Initialize Your Project
Link your workspace to a BuildShare project. In your project root directory, run:
buildshare initThe interactive wizard:
- Links to an existing project or helps you create a new one.
- Auto-detects your platform build directories (e.g.
./android/app/build/outputs/apk/releaseand./ios/builds). - Auto-detects your active Git branch.
- Generates a local
buildshare.jsonconfiguration file.
Step 3 — Upload a Build
Mandatory Project ID
All uploads require authentication and a valid project ID. When buildshare.json is configured, your project ID and build folders are resolved automatically.
Upload your platform build using the platform command:
# Upload Android APK from configured androidPath
buildshare upload android --notes "Sprint 42 test build"
# Upload iOS IPA from configured iosPath
buildshare upload ios --notes "Sprint 42 test build"You can also upload a specific file directly by providing your project ID:
buildshare upload ./app-release.apk --app <projectId>Once uploaded, the CLI renders an interactive progress bar, confirms the upload, and automatically sends installation notifications to your team and testers via email.
Step 4 — View Apps & Builds
List all applications registered in your active workspace along with their package names and platform identifiers:
buildshare app listTo inspect recent build history (auto-detects local buildshare.json or prompts with an interactive project picker):
buildshare build list
# Or target a specific project directly
buildshare build list --app <projectId>Next Steps
Explore the full command references and CI/CD automation guides: