Commands
The 30 commands of the hotcodepush CLI by task, from setting a project up through shipping an update to running the organization, one line each.
Every command is a noun and a verb, channel create, release rollback, or a bare word like init and login. One page per noun holds its verbs with their options and examples, and a bare command has its own page.
The sidebar lists them alphabetically after init and doctor. The tables below group them by what you are doing.
Every command takes the global options, prints one JSON document under --json and exits with the codes on the errors page. In a pipeline HOTCODEPUSH_TOKEN replaces login.
Set up a project
The first day: sign in, wire the project and check it.
| Command | Does |
|---|---|
| init | Set a project up from sign-in to the first release, re-runnable at any step. |
| doctor | Check the project's configuration, wiring, signing key, hosts and versions. |
| app | create, get, list, update, delete and transfer apps. |
| completion | Print the completion script for bash, fish or zsh. |
| login | Log in by approving a one-time code in the browser. --api-url points the CLI at another API. |
| logout | End the stored session and remove its token. |
| open | Open the app's console page in the browser, or a channel's. |
| whoami | Print the user you are logged in as and their organizations. |
Ship updates
The release path, from the build to the devices that take it, and the build step's own commands.
| Command | Does |
|---|---|
| audience | get the devices a release would reach before it exists. |
| binary | create a binary in the store build step, and list and get store builds. |
| bundle | upload, get, list and delete bundles. |
| channel | create, get, list, update, delete, pause and resume channels. |
| fingerprint | Print the project's native fingerprint, and diff two of them. |
| release | create, get, list, update, rollout, pause, resume, revoke and rollback releases. |
| resource-file | write the resource file in every build that is no store build. |
| signing-key | create, add, list and delete signing keys. |
Watch devices
What the fleet runs and why one device did not update.
| Command | Does |
|---|---|
| device | list, get and delete devices, and probe why one did not update. |
| statistics | get the fleet, updates or usage statistics of an app. |
Run the organization
Members, sign-in, billing and the records of what happened.
| Command | Does |
|---|---|
| audit-log | list the organization's audit log, filtered by type, actor, app and time. |
| checkout | create the checkout that enables billing on a free organization. |
| customer-portal-session | create a session of the portal with the invoices and the payment method. |
| invitation | create, accept, list and delete invitations. |
| limit | get one limit or list every limit in effect, with its default and override. |
| member | list, get, update and delete members, and transfer the ownership. |
| organization | create, get, list, update and delete organizations, and set the spending cap. |
| sso-provider | set, get, verify and delete the OIDC or SAML provider. |
| usage | get a month's monthly active devices and data transfer, and list them per app. |
Connect other systems
What leaves HotCodePush for your own tools.
| Command | Does |
|---|---|
| telemetry-export | set, get, update, test and delete the OpenTelemetry export. |
| telemetry-export-delivery | list the export's deliveries and redeliver one. |
| webhook | create, get, list, update, delete and test webhooks. |
| webhook-delivery | list a webhook's deliveries and redeliver one. |
Last updated on
CLI reference
The hotcodepush CLI, how to run it and sign in, and every command, the global options, the files, the exit codes, the errors and the telemetry.
init
The options, the nine steps, the prompts and the JSON document of hotcodepush init, the files it edits per framework and the repair by re-run.