FaceTagr Tools

FaceTagr Tools is the development-time companion package for the main FaceTagr SDK.

It provides CLI utilities that fetch and prepare all required FaceTagr assets from the cloud so they can be included properly during your Android/iOS build process.

FaceTagr Tools prepares required SDK assets during development to ensure seamless runtime initialization.


๐Ÿš€ Quick Start

  1. Add facetagr_tools to dev_dependencies
  2. Run flutter pub get
  3. Run the facetagr_init CLI command (see Setup section below)
  4. That's it โ€” FaceTagr Tools will automatically prepare all required SDK assets.

๐Ÿ’ก How It Works

FaceTagr Tools downloads required models and prepares build-time assets so that runtime SDK initialization happens instantly without additional network setup.

โœ… Requirements

  • Flutter 3.x+
  • Dart 3.x+

๐Ÿ“ฆ Installation (Development Only)

Platform Support

  • Android โœ”
  • iOS โœ”
  • Web โŒ (Not supported)

Add the following under dev_dependencies in your pubspec.yaml:

dev_dependencies:
  facetagr_tools: ^0.0.26  # Development-only CLI tools

flutter pub get

โš ๏ธ This package is for development only.

Do not include it under dependencies.

โš™๏ธ Setup โ€” Initialize Configuration

Run the following command to create a new config automatically:


dart run facetagr_tools:facetagr_init --clientID <clientID> --clientKey <clientKey> --apiURL <apiURL> --path <path>

Example

dart run facetagr_tools:facetagr_init \
  --clientID demo123 \
  --clientKey abc123xyz \
  --apiURL https://api.facetagr.com \
  --path /Users/john/.pub-cache/hosted/pub.dev

โœ… What this command does

  • Downloads FaceTagr model assets
  • Configures SDK environment
  • Prepares build-time dependencies

โš ๏ธ Security Note

Never commit your clientKey to public repositories.

Required Parameters

Parameter Description
--clientID Your FaceTagr client ID
--clientKey Secure client key used to generate authentication hash
--apiURL FaceTagr backend API base URL
--path Local Pub cache directory where models will be installed

๐Ÿ“ Path Examples

FaceTagr Tools requires the pub cache directory as --path.

Windows:

C:\Users\<USERNAME>\AppData\Local\Pub\Cache\hosted\pub.dev

Mac/Linux:

/Users/<USERNAME>/.pub-cache/hosted/pub.dev

๐Ÿ› ๏ธ Troubleshooting

Version mismatch

Update both SDK + Tools:

flutter pub upgrade facetagr
flutter pub upgrade facetagr_tools

Pub cache path not found

dart pub cache

๐Ÿงช Testing the Setup

After running the init command:

  1. Run your Flutter app
  2. Verify camera opens correctly
  3. Ensure FaceTagr models load without errors
  4. Successful initialization confirms setup

License

This package is part of the FaceTagr ecosystem.

ยฉ 2026 NotionTag Technologies Pvt Ltd. All rights reserved.

๐Ÿ’ฌ Support

For integration support, please contact:

๐Ÿ“ง support@facetagr.com

๐ŸŒ https://www.facetagr.com

Libraries