@aetherpush/cli 0.4.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +30 -34
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,26 +1,18 @@
1
1
  # Aether CLI
2
2
 
3
- > **Push React Native updates without the App Store.**
4
-
5
- The command-line interface for [Aether](https://aetherpush.com) — over-the-air JavaScript bundle updates for React Native apps.
3
+ The command-line interface for [Aether](https://aetherpush.com), over-the-air JavaScript bundle updates for React Native apps.
6
4
 
7
5
  [![npm version](https://img.shields.io/npm/v/@aetherpush/cli.svg)](https://www.npmjs.com/package/@aetherpush/cli)
8
6
  [![license](https://img.shields.io/npm/l/@aetherpush/cli.svg)](./LICENSE)
9
7
  [![node](https://img.shields.io/node/v/@aetherpush/cli.svg)](https://nodejs.org)
10
8
 
11
- > ⚠️ **Pre-release.** Aether is in active development. APIs and behavior may change before the first stable release.
12
-
13
- ---
9
+ The CLI follows semver and is on a 0.x line: a minor release may still change flags or output. Pin the exact version in CI and read the changelog before upgrading.
14
10
 
15
11
  ## Why Aether
16
12
 
17
- Microsoft retired App Center CodePush in March 2025, leaving thousands of React Native apps without an OTA update solution. Aether is a drop-in successor: same workflow, same client SDK contract, run by a small team focused on shipping.
13
+ Microsoft retired App Center CodePush in March 2025. Aether is a drop-in successor: the same release workflow, the same client contract, and a maintained SDK ([`@aetherpush/react-native-code-push`](https://www.npmjs.com/package/@aetherpush/react-native-code-push)) that replaces `react-native-code-push` without code changes. You release to named channels (Staging and Production by default), roll out to a percentage of devices, and roll back when a release goes wrong. Apps can be shared with collaborators.
18
14
 
19
- - **App Store-free deployments** — push bug fixes and updates directly to installed apps
20
- - **Compatible with `react-native-code-push`** today; first-party Aether SDK ships next
21
- - **Channel-based releases** — Staging, Production, Beta, whatever you need
22
- - **Rollouts and rollbacks** — percentage-based rollouts, instant rollback to any previous label
23
- - **Multi-collaborator** — own your apps, share access with your team
15
+ Full documentation lives at [docs.aetherpush.com](https://docs.aetherpush.com).
24
16
 
25
17
  ## Install
26
18
 
@@ -32,31 +24,33 @@ Requires Node.js 22 or later.
32
24
 
33
25
  ## Quick start
34
26
 
35
- ```sh
36
- # Create an account (interactive: prompts for email, name, password)
37
- aether register
27
+ 1. Create an account and log in. `register` asks for your email, name, and password, then sends a verification email; click the link before logging in.
38
28
 
39
- # Verify your email by clicking the link sent to you, then log in
40
- aether login
29
+ ```sh
30
+ aether register
31
+ aether login
32
+ ```
41
33
 
42
- # Create your first app (auto-provisions Staging and Production deployments)
43
- aether app add my-react-native-app
34
+ 2. Create an app. This also creates its Staging and Production deployments. Print the deployment keys and wire one into your app binary.
44
35
 
45
- # Inspect the deployment keys to wire into your app binary
46
- aether deployment ls my-react-native-app -k
36
+ ```sh
37
+ aether app add my-react-native-app
38
+ aether deployment ls my-react-native-app -k
39
+ ```
47
40
 
48
- # Release an update (auto-detects entry file and target binary version)
49
- aether release-react my-react-native-app ios
41
+ 3. Release an update. The command bundles the app and reads the target binary version from the project.
50
42
 
51
- # Roll out to 25% of users
52
- aether patch my-react-native-app Staging -r 25
43
+ ```sh
44
+ aether release-react my-react-native-app ios
45
+ ```
53
46
 
54
- # Promote a release from Staging to Production
55
- aether promote my-react-native-app Staging Production
47
+ 4. Manage the release: widen a rollout, promote it, or roll it back.
56
48
 
57
- # Roll back if something goes wrong
58
- aether rollback my-react-native-app Production
59
- ```
49
+ ```sh
50
+ aether patch my-react-native-app Staging -r 25
51
+ aether promote my-react-native-app Staging Production
52
+ aether rollback my-react-native-app Production
53
+ ```
60
54
 
61
55
  ## Commands
62
56
 
@@ -73,10 +67,11 @@ aether rollback my-react-native-app Production
73
67
  | `rollback` | Roll a deployment back to a previous release |
74
68
  | `collaborator add\|ls\|rm` | Manage app collaborators |
75
69
  | `access-key add\|ls\|patch\|rm` | Manage session-style CLI keys |
70
+ | `api-key add\|ls\|patch\|rm` | Manage scoped API keys for CI/CD |
76
71
  | `session ls\|rm` | Manage active login sessions |
77
72
  | `debug ios\|android` | Stream Aether logs from a running app |
78
73
 
79
- Full reference and flags: `aether <command> --help`.
74
+ Full reference and flags: `aether <command> --help`, or the [CLI reference](https://docs.aetherpush.com/cli/) in the docs.
80
75
 
81
76
  ## Hermes
82
77
 
@@ -104,20 +99,21 @@ aether login --serverUrl http://localhost:3000
104
99
  To run non-interactively (CI/CD):
105
100
 
106
101
  ```sh
107
- aether login --accessKey <your-access-key> --serverUrl https://api.aetherpush.com
102
+ aether login --accessKey <your-api-key>
108
103
  ```
109
104
 
110
105
  ## CI/CD
111
106
 
112
- Dedicated GitHub Action, GitLab CI / CircleCI / Jenkins templates, and a CLI `--ci` auto-detect flag are coming in the next release. For now, use `aether login --accessKey` with a long-lived access key.
107
+ The CLI detects CI environments through the `CI` variable and runs non-interactively there; `--ci` forces it. Ready-made pipeline templates for GitLab CI, CircleCI, and Jenkins live in [`examples/ci/`](./examples/ci/), and GitHub Actions has a dedicated action, [`aetherpush-deploy-action`](https://github.com/Monoradioactivo/aetherpush-deploy-action). The [CI/CD guides](https://docs.aetherpush.com/ci-cd/) walk through each platform.
113
108
 
114
109
  ## Migrating from CodePush
115
110
 
116
- If you're coming from `appcenter-cli` and `react-native-code-push`, a migration tool and step-by-step guide are on the way. Until then, your existing `react-native-code-push` SDK works against Aether servers unchanged — just swap your deployment key for one issued by `aether deployment ls -k`.
111
+ The [migration guide](https://docs.aetherpush.com/migration/codepush/) covers both routes. In short: the Aether SDK is a drop-in replacement for `react-native-code-push` on React Native 0.76 and newer, and older apps can keep Microsoft's SDK pointed at Aether's CodePush-compatible endpoints. Existing deployment keys can be preserved with `aether deployment add -k`, so shipped binaries keep updating.
117
112
 
118
113
  ## Links
119
114
 
120
115
  - Website: [aetherpush.com](https://aetherpush.com)
116
+ - Documentation: [docs.aetherpush.com](https://docs.aetherpush.com)
121
117
  - Issues: [GitHub](https://github.com/Monoradioactivo/aether-cli/issues)
122
118
 
123
119
  ## License
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aetherpush/cli",
3
- "version": "0.4.0",
3
+ "version": "0.4.1",
4
4
  "description": "Command-line interface for Aether — over-the-air updates for React Native apps.",
5
5
  "main": "./bin/script/index.js",
6
6
  "types": "./bin/script/index.d.ts",