/appcircle-cli

Primary LanguageJavaScriptMIT LicenseMIT

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-cli

Commands

Below is the list of commands currently supported by Appcircle CLI:

Command Description
appcircle login 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 Start a new build
appcircle upload Upload your app binary to selected distribution profile

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}. Copy the result and and set it as the AC_ACCESS_TOKEN enviroment variable.
  • Get the build profile ID using appcircle listBuildProfiles
  • Start a new build using appcircle build ${profileId} ${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}. Copy the result and and set it as the AC_ACCESS_TOKEN enviroment variable.
  • Get the distribution profile ID using appcircle listDistributionProfiles
  • Upload your app binary to the selected distribution profile using appcircle upload ${app} ${profileId} ${release_notes}