Skip to Content
Getting StartedInstallation

Installation

CLI Installation

Install the CLI globally via npm:

npm i -g @norrix/cli

Or use npx to run without installing:

npx @norrix/cli build ios release

Binary Aliases

The CLI registers two command aliases:

  • norrix: Primary command
  • nox: Short alias

Both work identically:

norrix build ios release
nox build ios release

Verify Installation

Check the installed version:

norrix --version

Client SDK Installation

Install the SDK in your NativeScript project:

npm install @norrix/client-sdk

What’s Included

The SDK package includes:

ComponentDescription
TypeScript SDKCore OTA update logic
iOS native moduleNative OTA loader for iOS
Android native moduleNative OTA loader for Android
NativeScript hooksAuto-configuration on ns prepare

Platform Requirements

PlatformMinimum Version
iOSNativeScript 8.0.0+
AndroidNativeScript 8.0.0+

Dependencies

The SDK installs these dependencies automatically:

  • @nativescript/zip: For extracting OTA bundles

Native Hooks

The SDK registers NativeScript hooks that run during ns prepare:

  • norrix-ota-ios: Configures iOS OTA loading
  • norrix-ota-android: Configures Android OTA loading

These hooks are registered in the package.json and run automatically.

Updating

Update CLI

npm update -g @norrix/cli

Update SDK

npm update @norrix/client-sdk

Note: SDK updates that change native code may require a new store build. Check the changelog  for breaking changes.

Quick StartAuthentication