Overview

This comprehensive migration guide helps you migrate from Instabug to Luciq Flutter SDK, covering all recent changes, API updates, and configuration requirements.

Summary of Core Changes:

Dependency: "instabug_flutter":xxx → "luciq_flutter": "xxx"

import package: instabug_flutter → "luciq_flutter"

Main Class: Instabug -> Luciq

Prerequisites

1. Ensure you have a clean git working directory (no uncommitted changes)
2. Make sure you’re using Instabug version 16.0.0 or later.
3. Make sure you're in the root directory of your Flutter project

Migration Script Usage

1. Pre-Migration Setup

Ensure clean git working directory
git status  
git add .  
git commit -m "Pre-migration commit"

Install Luciq CLI and need to be called if there is a version

for luqic_cli to migrate from instabug to the latest Luciq version

dart pub global activate luciq_cli

2. Run Migration Script

# Dry run first to preview changes
luciq-cli migrate --dry-run

# Run actual migration
luciq-cli migrate

3. Update Dependencies

# pubspec.yaml
dependencies:
  luciq_flutter: ^18.0.0
  luciq_dio_interceptor: ^3.0.0  # Optional
  luciq_http_client: ^3.0.0    # Optional
  luciq_flutter_modular: ^2.0.0  # Optional

4. SDK Initialization

// New initialization pattern
await Luciq.init(
  token: 'YOUR_TOKEN',
  invocationEvents: [InvocationEvent.shake],
  debugLogsLevel: LogLevel.error,
  appVariant: 'production', // New optional parameter
);

5. Private Views API

// New private views configuration
LuciqWidget(
  child: MyApp(),
  enablePrivateViews: true,
  enableUserSteps: true,
  automasking: [
    AutoMasking.allTextFields(),
    AutoMasking.allButtons(),
  ],
)

API Reference

Main Module

Configuration

Environment Variables

Test Migration

# Run tests
flutter test

# Build and test on devices
flutter build apk --release
flutter build ios --release

Why was it named luciq-cli instead of luciq?

We changed the Flutter CLI luciq command to luciq-cli to avoid conflicts with React Native Cli.

Getting Help

Documentation: Luciq Flutter Documentation

GitHub Issues: Luciq Flutter GitHub