Documentation

interface UpfluxConfig {
  appId: string;       // Your Upflux app ID
  deployment: string;  // Target deployment (e.g., 'production')
  clientKey: string;   // Client API key (upx_cli_xxx)
  serverUrl: string;   // Server URL
  collectDeviceInfo?: boolean; // Collect device info (default: true)
}

// Reads upflux.json, auto-selects profile, runs update check in background
const { instance, startupBundle } = await Upflux.init();

// With explicit profile
await Upflux.init('production');

// With lifecycle callbacks — intercept any stage
await Upflux.init('production', {
  // Unblock splash screen immediately when check finishes
  onCheckComplete: (hasUpdate) => {
    if (!hasUpdate) setCheckingUpdate(false);
  },
  onUpdateAvailable: async (info, actions) => {
    // You control download + apply timing
    setLoading(true);
    const result = await actions.download();
    setLoading(false);
    await actions.apply(result);
  },
  onDownloadProgress: ({ percentage, bytesDownloaded, totalBytes }) => {
    setProgress(percentage);
  },
  onUpdateQueued: (info) => showToast('Update ready on next launch: ' + info.releaseLabel),
  onUpdateApplied: () => console.log('Restarting with new bundle'),
  onRollback: ({ rolledBackFrom, rolledBackTo }) => {
    console.warn('Rolled back from ' + rolledBackFrom + ' to ' + rolledBackTo);
  },
  onError: (err) => console.warn('Update failed:', err.message),
});

const updateInfo = await upflux.checkForUpdates();

// Returns UpdateInfo:
// {
//   updateAvailable: boolean,
//   storeUpdateRequired?: boolean,    // true = device needs store update first
//   requiredBinaryVersion?: string,   // minimum binary version required
//   releaseLabel: string,
//   downloadUrl: string,
//   mandatory: boolean,
//   description: string
// }

const result = await upflux.downloadUpdate(updateInfo, {
  timeout: 45000, // Optional timeout in ms (default: 60000ms / 60s)
  onProgress: ({ percentage, bytesDownloaded, totalBytes }) => {
    // 0–60% JS bundle, 60–100% assets
    console.log('Progress: ' + percentage + '% (' + bytesDownloaded + '/' + totalBytes + ' bytes)');
  }
});

// Returns DownloadResult:
// {
//   success: boolean,
//   bundlePath: string,
//   assetPaths: string[],
//   error?: string
// }

const applyResult = await upflux.applyUpdate(downloadResult);

// Returns ApplyResult:
// {
//   applied: boolean,
//   bundlePath: string | null,
//   deferred?: boolean, // true if installMode is 'on_next_restart'
//   error?: string
// }
// Note: App will restart before this returns if immediate

upflux init

# Output:
# 🚀 Upflux Project Setup
#
# ? App ID: my-app
# ? Server URL (press Enter for default):
# ? Deployment profiles to create: production, staging, development
# ? Client key for "production": upx_cli_prd_xxxxx
# ? Client key for "staging": upx_cli_stg_xxxxx
# ? Client key for "development": upx_cli_dev_xxxxx
#
# ✓ Created upflux.json

# Overwrite an existing upflux.json:
upflux init --force

# Non-interactive (recommended)
upflux login --key <publishKey>

# Example with multiple deployments
upflux login --key upx_pub_staging_xxxxx
upflux login --key upx_pub_production_xxxxx

# Credentials are stored locally in .upflux file

upflux status

# Shows:
# - Current deployment
# - Latest releases
# - Active devices count
# - Update success rate

# Interactive selection to remove one credential
upflux logout

# Remove all credentials at once
upflux logout --all

# Display manifest for a release
upflux generate-manifest --release-id <releaseId>

# Save manifest to a file
upflux generate-manifest --release-id <releaseId> --output manifest.json