playpush
Version:
## Overview
91 lines (50 loc) • 2.72 kB
Markdown
# Playpush CLI
## Overview
The PlayPush CLI tool is designed to facilitate the process of uploading Android App Bundles (AAB) to the Google Play Store. It provides a simple command-line interface (CLI) for managing the upload of your application bundles, setting release notes, and specifying the release track.
## Examples
1. Upload an App Bundle to beta channel:
```bash
npx playpush -v 1.0.0 -p com.example.myapp -b /path/to/app.aab -t beta
```
2. Upload an App Bundle providing keyfile:
```bash
npx playpush -c /path/to/keyfile.json -v 1.0.0 --p com.example.myapp -b /path/to/app.aab
```
3. Upload an App Bundle with release notes:
```bash
npx playpush -c /path/to/keyfile.json -v 1.0.0 -n "Initial release" -p com.example.myapp -b /path/to/app.aab
```
## Requirements
In order to use this tool you need to:
- [Create a Google service account and JSON keyfile](documentation/CreateServiceAccount.md)
- [Add the service account to you Google Play Console](documentation/AddServiceAccount.md)
## Environment Variables
- Set the CREDENTIALS_KEYFILE env variable to specify the path to the `keyfile.json` file. If not provided through the command-line options, this variable will be used.
## Options
### Global Options
`--version`
- Displays the version of PlayPush.
`-h, --help`
- Displays help information for the command.
### Upload Options
`-p, --package-name <name>`
- Description: The package name of the app (e.g., com.example.myapp).
`-b, --bundle <path>`
- Description: Path to the Android App Bundle (AAB) file that you want to upload.
`-v, --app-version-name <name>`
- Description: Specifies the version name of the app to be uploaded.
`-c, --credentials-file-path <path> (optional)`
- Description: Path to the `keyfile.json` file.
- Default: Value of the `CREDENTIALS_KEYFILE` environment variable
`-n, --release-notes <notes> (optional)`
- Description: Provides release notes for the app version.
`-l, --release-notes-language <locale> (optional)`
- Description: Language localization code for the release notes in BCP-47 format. Defaults to "en-US" if not specified.
- Default: en-US
`-t, --track <track> (optional)`
- Description: Release track for the app. Possible values are "alpha", "beta", "production", and "internal". Defaults to "internal".
- Default: internal
`--changesNotSentForReview`
- Description: Indicates that the changes in this edit will not be reviewed until they are explicitly sent for review from the Google Play Console UI. These changes will be added to any other changes that are not yet sent for review.
## Additional Notes
Ensure that you have valid credentials and the necessary permissions to upload bundles to the Google Play Store.