channel
Create, update, pause, resume and delete channels with hotcodepush channel, including preview channel expiry and the auto-pause policy.
hotcodepush channel manages an app's channels, the stream of releases a group of devices follows.
The flag --channel <id|name> names one. Defaults to hotcodepush.json's channel, or production when the file names none.
create
Create a channel in an app, with an expiry for a preview channel and its auto-pause policy.
The flags --expires-in and --expires-at exclude each other, and a --failure-* flag left out leaves the default auto-pause policy in place.
| Option | Type | Description |
|---|---|---|
--discoverable | boolean | Whether the app's setChannel finds the channel by its name. Pass false to turn it off. |
--expires-at <timestamp> | string | When the preview channel expires, an ISO 8601 timestamp. Protected and default channels have none. |
--expires-in <duration> | string | How long until the preview channel expires, 14d or 12h. |
--failure-action <action> | none | notify | pause | revoke | What auto-pause does when a release fails too often: pause, revoke, notify or none. |
--failure-minimum-update-count <count> | number | The applied updates a release needs before auto-pause judges it. |
--failure-threshold-percent <percent> | number | The failure percentage at which auto-pause acts. |
--if-not-exists | boolean | Return the channel of that name when it exists instead of failing, for re-run pipelines. |
--name <name> | string | The name: letters, digits, - and _, one to 64 characters, unique in the app. |
--protected | boolean | Whether only Owners and Admins change what the channel serves. Pass false to turn it off. |
hotcodepush channel create --name staging --protected
hotcodepush channel create --name pr-42 --expires-in 14d --if-not-exists --jsonget
Print a channel with its device counts, hotcodepush.json's by default. The device counts appear in the text output only.
| Option | Type | Description |
|---|---|---|
--channel <id|name> | string | The channel, by id or name. Defaults to hotcodepush.json's channel. |
hotcodepush channel get
hotcodepush channel get --channel staging --jsonlist
List an app's channels, newest first.
| Option | Type | Description |
|---|---|---|
--limit <count> | number | How many to list, at most 100; 50 by default. |
--offset <count> | number | How many to skip: the offset the previous page ended with. |
hotcodepush channel list
hotcodepush channel list --app "My App" --jsonupdate
Rename a channel or change its flags, expiry and auto-pause policy.
A flag left out leaves its field as it is, and a --clear-* flag sets one back to null. --protected false and --discoverable false turn the flags off.
| Option | Type | Description |
|---|---|---|
--channel <id|name> | string | The channel, by id or name. Defaults to hotcodepush.json's channel. |
--clear-expires-at | boolean | Sets the expiry back to null: the channel never expires. |
--clear-failure-action | boolean | Sets the action back to null: the default policy applies. |
--clear-failure-minimum-update-count | boolean | Sets the minimum update count back to null: the default policy applies. |
--clear-failure-threshold-percent | boolean | Sets the threshold back to null: the default policy applies. |
--discoverable | boolean | Whether the app's setChannel finds the channel by its name. Pass false to turn it off. |
--expires-at <timestamp> | string | When the preview channel expires, an ISO 8601 timestamp. Protected and default channels have none. |
--expires-in <duration> | string | How long until the preview channel expires, 14d or 12h. |
--failure-action <action> | none | notify | pause | revoke | What auto-pause does when a release fails too often: pause, revoke, notify or none. |
--failure-minimum-update-count <count> | number | The applied updates a release needs before auto-pause judges it. |
--failure-threshold-percent <percent> | number | The failure percentage at which auto-pause acts. |
--name <name> | string | The channel's new name: letters, digits, - and _, one to 64 characters. |
--protected | boolean | Whether only Owners and Admins change what the channel serves. Pass false to turn it off. |
hotcodepush channel update --channel staging --protected
hotcodepush channel update --channel pr-42 --expires-in 7d --jsondelete
Delete a channel and its releases. Devices on it keep what they have.
Confirms once (--yes in a script). --ignore-not-found makes a channel that is already gone a success, for a pipeline run again.
The text output names how many devices were on the channel, and --json prints only its id and name.
| Option | Type | Description |
|---|---|---|
--channel <id|name> | string | The channel, by id or name. Defaults to hotcodepush.json's channel. |
--ignore-not-found | boolean | Succeed when the channel does not exist, for re-run pipelines. |
hotcodepush channel delete --channel staging
hotcodepush channel delete --channel pr-42 --ignore-not-found --yes --jsonpause
Pause a channel, the kill switch: it serves nothing new until resumed.
Confirms once (--yes in a script) and applies within about a minute (How an update reaches a device). Pausing one release instead is release pause.
| Option | Type | Description |
|---|---|---|
--channel <id|name> | string | The channel, by id or name. Defaults to hotcodepush.json's channel. |
hotcodepush channel pause --channel production
hotcodepush channel pause --channel production --yes --jsonresume
Resume a paused channel: it serves its releases again.
Confirms once (--yes in a script) and applies within about a minute (How an update reaches a device).
| Option | Type | Description |
|---|---|---|
--channel <id|name> | string | The channel, by id or name. Defaults to hotcodepush.json's channel. |
hotcodepush channel resume --channel production
hotcodepush channel resume --channel production --yes --jsonLast updated on