@otalan/cli 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+https://www.apache.org/licenses/LICENSE-2.0
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!) The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/NOTICE

@@ -0,0 +1,8 @@
+Otalan CLI
+
+Copyright 2026 Cirtadev GmbH
+
+Licensed under the Apache License, Version 2.0.
+You may obtain a copy of the License at:
+
+    https://www.apache.org/licenses/LICENSE-2.0

package/README.md

@@ -0,0 +1,432 @@
+# `@otalan/cli`
+
+Otalan CLI for bundling and publishing OTA update releases for Capacitor and Expo / React Native apps.
+
+Published as an npm package, but the CLI itself runs on Bun.
+
+## Requirements
+
+- Bun `>= 1.3.11` installed and available on your `PATH`
+- An Otalan **CI key**
+
+Do not use the OTA app key in the CLI.
+
+## Platform Support
+
+The npm package ships a Bun-based CLI entrypoint, not standalone native binaries.
+
+- macOS and Linux are supported when Bun `>= 1.3.11` is installed.
+- Windows support is experimental until the CLI release flow is validated on Windows.
+- Native compile scripts exist for macOS, Linux, and Windows maintainers, but the compiled binaries are not included in the npm package.
+
+## Install
+
+Recommended:
+
+```bash
+bun add -g @otalan/cli
+```
+
+If you install the package with `npm`, `pnpm`, or `yarn`, `bun` still needs to be installed because the executable runs with `#!/usr/bin/env bun`.
+
+Local development from this repo:
+
+```bash
+bun ./src/bin.ts help
+```
+
+## Quick Start
+
+### Capacitor
+
+1. Log in with your CI key:
+
+```bash
+otalan login --api-key otalan_ci_xxx
+```
+
+2. Link the current repo to your active Otalan app:
+
+```bash
+otalan init --app-id com.example.app
+```
+
+3. Build your web assets with your app's normal build command.
+
+4. Bundle the OTA payload:
+
+```bash
+otalan bundle --target capacitor --platform ios --bundle-id 1.0.5
+```
+
+5. Publish the release:
+
+```bash
+otalan publish --channel production
+```
+
+`otalan bundle --target capacitor` packages the built web assets from `dist/` or `www/`, so your app build must run first.
+`otalan publish` waits for server-side validation to finish before it returns.
+
+### Expo / React Native
+
+1. Log in with your CI key:
+
+```bash
+otalan login --api-key otalan_ci_xxx
+```
+
+2. Link the current repo to your active Otalan app:
+
+```bash
+otalan init --app-id com.example.app
+```
+
+3. Bundle the OTA payload:
+
+```bash
+otalan bundle --target expo --platform ios --bundle-id 1.0.5
+```
+
+4. Publish the release:
+
+```bash
+otalan publish --channel production
+```
+
+`otalan bundle --target expo` runs `bunx expo export`, packages the exported JS bundle and assets, and stores the resolved Expo config in the Otalan manifest for publish.
+`otalan publish` waits for server-side validation to finish before it returns.
+
+## CI/CD Usage
+
+The CLI is designed to work well in CI/CD with a project-scoped Otalan CI key.
+
+Set these secrets in your CI provider:
+
+- `OTALAN_API_KEY`
+- `OTALAN_APP_ID` for an active app
+
+Optional:
+
+- `OTALAN_API_URL`
+
+### CI/CD Example: Capacitor
+
+```bash
+bun install --frozen-lockfile
+bun run build
+otalan login --api-key "$OTALAN_API_KEY" --api-url "${OTALAN_API_URL:-https://api.otalan.com}"
+otalan init --app-id "$OTALAN_APP_ID"
+otalan bundle --target capacitor --platform ios --bundle-from-package
+otalan publish --channel production
+```
+
+Use your normal app build command before `otalan bundle`. The CLI then packages the built web output from `dist/` or `www/`.
+
+### CI/CD Example: Expo / React Native
+
+```bash
+bun install --frozen-lockfile
+otalan login --api-key "$OTALAN_API_KEY" --api-url "${OTALAN_API_URL:-https://api.otalan.com}"
+otalan init --app-id "$OTALAN_APP_ID"
+otalan bundle --target expo --platform ios --bundle-from-package
+otalan publish --channel production
+```
+
+This runs `bunx expo export` through the CLI, packages the exported OTA assets, and publishes the resulting bundle through Otalan's validation pipeline.
+
+### GitHub Actions Example
+
+```yaml
+name: Publish OTA
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish-ios:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: 1.3.11
+
+      - run: bun install --frozen-lockfile
+      - run: bun add -g @otalan/cli
+      - run: bun run build
+      - run: otalan login --api-key "$OTALAN_API_KEY"
+        env:
+          OTALAN_API_KEY: ${{ secrets.OTALAN_API_KEY }}
+      - run: otalan init --app-id "$OTALAN_APP_ID"
+        env:
+          OTALAN_APP_ID: ${{ secrets.OTALAN_APP_ID }}
+      - run: otalan bundle --target capacitor --platform ios --bundle-from-package
+      - run: otalan publish --channel production
+```
+
+Adjust the build step and bundle target for your app:
+
+- Capacitor: keep your web build step and use `--target capacitor`
+- Expo / React Native: remove the web build step if not needed and use `--target expo`
+
+## What It Does
+
+- logs into the Otalan API
+- checks API connectivity and CI key context
+- links the current repo to an Otalan app
+- bundles Capacitor or Expo / React Native OTA output
+- publishes a bundle with rollout metadata
+- lists published bundles
+- rolls back to an older bundle
+- shows current bundle status
+
+The CLI supports one release write path: `otalan publish`. There is no separate `upload` command.
+
+## Config Files
+
+Global auth config:
+
+```text
+~/.otalan/config.json
+```
+
+Project config:
+
+```text
+otalan.config.json
+```
+
+Example project config:
+
+```json
+{
+  "organizationSlug": "test-org-407b69f7",
+  "projectSlug": "test-project-ca3bcb8a",
+  "appId": "com.example.app"
+}
+```
+
+`otalan.config.json` only links the repo to an Otalan project/app. Bundle and release targeting data such as `target`, `platform`, `nativeVersion`, and `bundleId` live in `.otalan/bundle/manifest.json`.
+
+## Command Reference
+
+### `otalan help`
+
+Shows the available commands.
+
+### `otalan login`
+
+Saves the CI key and API base URL locally.
+
+```bash
+otalan login --api-key otalan_ci_xxx --api-url https://api.otalan.com
+```
+
+Local development:
+
+```bash
+otalan login --api-key otalan_ci_xxx --api-url http://localhost:8787
+```
+
+### `otalan doctor`
+
+Checks API connectivity and prints the organization/project context resolved from the configured CI key.
+
+```bash
+otalan doctor
+```
+
+CI usage without saved local auth:
+
+```bash
+otalan doctor --api-key "$OTALAN_API_KEY" --api-url "${OTALAN_API_URL:-https://api.otalan.com}"
+```
+
+### `otalan init`
+
+Creates `otalan.config.json` in the current project.
+
+`appId` is the registered app ID shown under the app name on the Apps page in Otalan. It is scoped to the current project, not globally unique across all projects. The app must be active; archived apps are treated as unavailable for CI publish, rollback, status, and bundle listing commands.
+
+If you already ran `otalan login`, the CLI resolves `organizationSlug` and `projectSlug` automatically from the CI key and stores them as a safety check.
+
+```bash
+otalan init \
+  --app-id app.cryptosan.app
+```
+
+### `otalan bundle`
+
+Builds `.otalan/bundle/bundle.zip` and `.otalan/bundle/manifest.json`.
+
+Capacitor:
+
+```bash
+otalan bundle --target capacitor --platform ios
+```
+
+Expo / React Native:
+
+```bash
+otalan bundle --target expo --platform ios
+```
+
+Current behavior:
+
+- Build your Capacitor web assets before running `otalan bundle`
+- Capacitor reads `dist/` or `www/`
+- Expo runs `bunx expo export --platform <platform>`
+- Expo stores the resolved Expo app config in `.otalan/bundle/manifest.json` so publish can forward it for `extra.expoClient`
+- both outputs produce a ZIP plus `manifest.json`
+- `--platform` is required so the CLI exports the selected platform and resolves the correct native/runtime version
+
+Native version defaults:
+
+- Capacitor iOS reads `CFBundleShortVersionString` from `Info.plist` and resolves `$(MARKETING_VERSION)` from the Xcode project when needed
+- Capacitor Android reads `versionName` from `android/app/build.gradle` or `build.gradle.kts`
+- Expo reads the selected platform version from Expo config and falls back to the top-level Expo `version`
+- Expo runtimeVersion reads `--runtime-version`, Expo export metadata, or Expo config runtimeVersion policies/strings
+- `--native-version` overrides auto-detection
+
+Choose the bundle ID you want to release:
+
+```bash
+otalan bundle --target capacitor --platform ios --bundle-id 1.0.5
+otalan bundle --target expo --platform ios --bundle-id 1.0.5
+```
+
+`bundleId` is the customer-facing OTA release identifier for all targets. The CLI maps it to the target-specific metadata internally.
+
+If you omit `bundleId`:
+
+- the CLI reads `nativeVersion` from the selected native platform and adds a short hash suffix
+- example: `1.0.0-abc123def456`
+
+If you want to take the bundle ID from `package.json` instead:
+
+```bash
+otalan bundle --target capacitor --platform ios --bundle-from-package
+```
+
+### `otalan publish`
+
+Publishes the current bundle output with rollout metadata.
+
+`otalan publish` uses the `bundleId`, `platform`, and `nativeVersion` already stored in `.otalan/bundle/manifest.json`. To release `1.0.5`, set it when you run `otalan bundle --bundle-id 1.0.5`.
+
+Current behavior:
+
+- `channel` is chosen at publish time
+- `--platform` and `--native-version` can override the manifest, but only if they match it
+- `--output-dir` lets you publish a bundle from a non-default folder
+- Expo publish forwards the stored Expo app config when present
+- Otalan validates the release ZIP before the publish completes
+
+Default flow:
+
+```bash
+otalan publish --channel production
+```
+
+This uses `POST /v1/releases/create` and waits for `GET /v1/releases/ingests/:id` to reach `ready` before returning success.
+
+If validation fails, `otalan publish` exits non-zero and prints the ingest failure reason when the API provides one. This makes the command safe to use directly in CI/CD pipelines.
+
+### `otalan bundles`
+
+Lists remote bundles for the current app so you can choose a bundle for rollback or rollout operations.
+
+Default resolution order:
+
+1. `--native-version`
+2. `.otalan/bundle/manifest.json` if present and the manifest platform matches the selected platform
+3. native version derived from the selected platform in the local app project
+4. interactive prompt
+
+```bash
+otalan bundles --platform ios --channel production
+```
+
+### `otalan rollback`
+
+Reactivates an older bundle for the same tuple.
+
+`rollback` uses the same native-version default order as `bundles`. Pass `--native-version` if you want to override the detected default.
+
+```bash
+otalan rollback --bundle-id 1.0.0-web.1 --platform ios --channel production
+```
+
+### `otalan status`
+
+Shows the active bundle for the selected release tuple.
+
+`status` also uses the same native-version default order as `bundles`.
+
+```bash
+otalan status --platform ios --channel production
+```
+
+## Bundle Output
+
+### Capacitor Manifest
+
+```json
+{
+  "target": "capacitor",
+  "hash": "sha256...",
+  "nativeVersion": "1.0.0",
+  "bundleId": "1.0.0-abcdef123456",
+  "createdAt": "2026-04-07T12:00:00.000Z",
+  "platform": "ios"
+}
+```
+
+### Expo Manifest
+
+```json
+{
+  "target": "expo",
+  "hash": "sha256...",
+  "nativeVersion": "1.0.0",
+  "runtimeVersion": "1.0.0",
+  "bundleId": "1.0.0-abcdef123456",
+  "launchAsset": "bundles/ios-xxxxx.js",
+  "assets": [
+    "assets/asset_1.png"
+  ],
+  "expoConfig": {
+    "name": "Example",
+    "slug": "example",
+    "scheme": "example"
+  },
+  "createdAt": "2026-04-07T12:00:00.000Z",
+  "platform": "ios"
+}
+```
+
+## Maintainer Release Checklist
+
+Before publishing a public package release:
+
+```bash
+bun install --frozen-lockfile
+bun test
+bun run check
+bun run lint
+bun run build
+bun pm pack --dry-run
+```
+
+`prepublishOnly` reruns tests, TypeScript, and ESLint. The scoped npm package is configured for public publishing through `publishConfig.access`.
+
+## Notes
+
+- This is a Bun-based CLI published on npm.
+- Expo / React Native bundling uses `bunx expo ...`.
+- Default API URL is `https://api.otalan.com`.
+- Local development API URL is `http://localhost:8787`.
+- Publishing, rollback, status, and `bundles` expect a CI key and an active app.
+- Run `bun run build` after changing CLI source if you want `dist/bin.js` updated locally.