1.1.1 • Published 3 years ago
appcircle-cli v1.1.1
Appcircle Command Line Interface
Appcircle CLI is a unified tool for accessing the Appcircle platform features from the command line.
Installation
npm install -g appcircle-clior you can install locally (requires npx to use)
npm install appcircle-cliCommands
Below is the list of commands currently supported by Appcircle CLI:
| Command | Description |
|---|---|
appcircle | AppCircle GUI |
appcircle login [--pat] | Get an access token for the session |
appcircle listBuildProfiles | Get the list of build profiles |
appcircle listDistributionProfiles | Get the list of distribution profiles |
appcircle build [--profileId] [--branch] | Start a new build |
appcircle download [--path] [--commitId] [--buildId] | Download the artifact under the selected path |
appcircle upload [--app] [--message] [--profileId] | Upload your app binary to selected distribution profile |
appcircle createDistributionProfile [--name] | Create a distribution profile |
appcircle listEnvironmentVariableGroups | Get list of environment variable groups |
appcircle createEnvironmentVariableGroup [--name] | Create an environment variable group |
appcircle listEnvironmentVariables [--variableGroupId] | Get list of environment variables |
appcircle createEnvironmentVariable [--type] [-isSecret, --isSecret] [--variableGroupId] [--key] [--value] [--filePath] | Create a file or text environment variable |
How to start a new build via the Appcircle CLI?
- Add a build profile and connect a repository
- Generate a personal access token from the Appcircle dashboard
- Using the Appcircle CLI, create a full access API token using the following command with the personal access token specified as "pat":
appcircle login --pat="YOUR PERSONAL ACCESS TOKEN". Copy the result and and set it as theAC_ACCESS_TOKENenviroment variable. - Get the build profile ID using
appcircle listBuildProfiles - Start a new build using
appcircle build --profileId="YOUR PROFILE ID" --branch="YOUR BRANCH"
How to distribute an app via the Appcircle CLI?
- Create a distribution profile and share with the testers
- Enable auto sending of the build to the testers
- Generate a personal access token from the Appcircle dashboard
- Using the Appcircle CLI, create a full access API token using the following command with the personal access token specified as "pat":
appcircle login --pat="YOUR PERSONAL ACCESS TOKEN". Copy the result and and set it as theAC_ACCESS_TOKENenviroment variable. - Get the distribution profile ID using
appcircle listDistributionProfiles - Upload your app binary to the selected distribution profile using
appcircle upload --app="YOUR APP PATH" --profileId="YOUR PROFILE ID" --message="YOUR RELEASE NOTES"