Skip to Content
Getting StartedQuick Start

Quick Start

Get your first OTA update deployed in under 10 minutes.

Prerequisites

  • Node.js 18+
  • A NativeScript 8+ project
  • Apple Developer account (for iOS builds)
  • Google Play Console account (for Android builds)

1. Install the CLI

npm i -g @norrix/cli

Verify the installation:

norrix --version

2. Sign In

Authenticate with your Norrix account:

norrix sign-in

This opens a browser window for authentication. Once complete, your session is stored locally.

3. Add the Client SDK

Install the SDK in your NativeScript project:

npm install @norrix/client-sdk

4. Initialize the SDK

Add the SDK initialization as early as possible in your app (typically in app.ts or main.ts):

import { initNorrix } from '@norrix/client-sdk';
 
initNorrix({
  updateUrl: 'https://norrix.net',
  checkForUpdatesOnLaunch: true,
  installUpdatesAutomatically: true,
});

5. Run Your First Build

Build your app in the cloud:

# iOS release build
norrix build ios release
 
# Android release build
norrix build android release

The CLI uploads your project, triggers a cloud build, and returns a build ID. You can check status with:

norrix build-status <buildId>

6. Publish an OTA Update

After your initial store build is deployed, publish JavaScript updates instantly:

norrix update ios 1.0.1

Devices running your app will receive the update on their next launch.

What’s Next?

OverviewInstallation