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
- Add
facetagr_toolstodev_dependencies - Run
flutter pub get - Run the
facetagr_initCLI command (see Setup section below) - 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.27 # 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
clientKeyto 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:
- Run your Flutter app
- Verify camera opens correctly
- Ensure FaceTagr models load without errors
- 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