zakin
v1.0.14
Published
CLI to authenticate with Zakin Hot Updater API and save OTA deploy credentials to .env
Maintainers
Readme
zakin
Zakin CLI is a command-line tool for authenticating with the Zakin Hot Updater platform and configuring OTA deployment for React Native applications.
CLI to authenticate with Zakin Hot Updater and configure OTA deployment for React Native applications.
Features
- Authenticate with the Hot Updater API
- Generate
.envwith deploy credentials - Support iOS and Android OTA deployments
- Compatible with
hot-updater
Install
npm install zakinyarn add zakinOr run without installing:
npx zakin --helpUsage
Log in and save credentials to .env in the current directory:
zakin login -u <username> -p <password> -k <app-key>Optional flags:
# Custom app ID (default: customer-app)
zakin login -u <username> -p <password> -k <app-key> -i customer-app
# Custom API server (default: https://hotupdaterapi.zakin.sbs)
zakin login -u <username> -p <password> -k <app-key> -h http://localhost:4111CLI help:
zakin --help
zakin login --helpEnvironment variables
The login command writes these variables to .env:
| Variable | Description |
| --- | --- |
| ZAKIN_UPDATER_APP_ID | Application ID |
| ZAKIN_UPDATER_APP_KEY | Application key |
| ZAKIN_ACCESS_TOKEN | JWT access token |
Optional manual configuration:
| Variable | Description |
| --- | --- |
| ZAKIN_SERVER_URL | Custom API server URL |
Deploy OTA updates
After login, deploy from your React Native project:
# iOS
npm run deploy:ios -- -t 1.0.0
# Android
npm run deploy:android -- -t 1.0.0Requirements
- Node.js 18+
- npm or yarn
- React Native project with
hot-updaterconfigured
