bright-sdk-integration — BrightSDK Integration Code Generator

Quick Start

No installation required — run directly with npx:

one-liner

npx github:BrightSDK/bright-sdk-integration --platform
                        <platform>

Or install globally for repeated use:

npm install -g github:BrightSDK/bright-sdk-integration

# Then run anywhere:
bright-sdk-integration --platform webos
bright-sdk-integration --platform tizen
bright-sdk-integration --platform ios

Prerequisites

Node.js ≥ 18 (tested on v18, v20, v22)
SDK_API_KEY environment variable — How to obtain an API key

Supported Platforms

Android

Features

⬇️

Download & Extract SDK Fetches the correct SDK version for your platform, verifies integrity, and extracts it.

⚙️

Auto-configure project Patches Xcode projects, .csproj files, or copies SDK assets into your app structure.

🔄

Update existing integration Bumps SDK version in-place without losing your config or consent flow settings.

🧩

Interactive mode Prompts for app ID, version, and paths — or pass them via CLI flags for CI/CD.

🦀

Rust-powered downloads Uses bright-sdk-downloader-rs for fast, safe SDK fetching with SHA-256 verification.

📋

Config generation Saves a .brightsdk.json config for repeatable builds and future updates.

CLI Usage

# Set your API key
export SDK_API_KEY=<your-api-key>

# New integration — interactive wizard
bright-sdk-integration --platform webos

# Update existing SDK version
bright-sdk-integration --platform ios --update

# Non-interactive (CI/CD)
bright-sdk-integration --platform tizen \
  --app-id com.example.myapp \
  --version latest \
  --dir ./my-tizen-app

Options

Flag	Description	Default
`--platform, -p`	Target platform (webos, tizen, ios, tvos, macos, windows)	—
`--update, -u`	Update existing integration to latest SDK version	false
`--interactive, -i`	Force interactive prompts	true (TTY)
`--app-id`	Application identifier	prompted
`--version, -v`	SDK version to use	latest
`--dir, -d`	Working directory	cwd

Examples

Each platform includes a fully working example app with README and integration walkthrough:

Apple (iOS / tvOS / macOS) — SwiftUI sample app with consent flow
WebOS — LG WebOS TV sample app
Tizen — Samsung Tizen TV sample app
Windows — WinUI 3 / .NET sample app with .csproj patching

API Key

All operations require an SDK_API_KEY environment variable.

Log in to the BrightSDK Control Panel → API keys
Click + Add, choose an expiration, name the key, click Generate key
Copy the key immediately — it is shown only once
Export it:
```
export SDK_API_KEY=<your-api-key>
```

Full guide with screenshots →

Development

# Clone
git clone https://github.com/BrightSDK/bright-sdk-integration.git
cd bright-sdk-integration
npm install

# Run tests
npm test

# Lint & format
npm run validate

# Run locally against an example
git clone https://github.com/BrightSDK/bright-sdk-integration-example-webos.git
cd bright-sdk-integration-example-webos
npm start