A Node.js command line application that processes JPEG 1, PNG, and HEIC/HEIF files and outputs structured JSON results including Trust Indicator Sets, as defined in ISO 21617-1.
- 📁 File Processing: Process files and extract Trust Indicator Sets by default
- 📊 Content Analysis: Provides useful information about the file and its content
- 🎯 JSON Output: Generate structured JSON in various syntaxes
- 🎨 Pretty Printing: Support for both minified and pretty-printed JSON output
- 📂 Directory Management: Automatically creates output directories as needed
- ✅ Error Handling: Graceful error handling with informative messages
- 🧪 Well Tested: Comprehensive test suite with Jest
- 🔍 Code Quality: ESLint configuration for consistent code style
# Clone the repository
git clone https://gitlab.com/your-username/indicator-extractor.git
cd indicator-extractor
# Install dependencies
npm install
# Install globally (optional)
npm install -g .# Process a single file with Trust Indicator Set (output to same directory as input file)
indicator-extractor input.jpg
# Process a file with Trust Indicator Set and pretty-printed JSON output
indicator-extractor input.png --pretty
# Process a file with basic content analysis only (no indicator set)
indicator-extractor input.jpg --basic
# Process multiple files at once
indicator-extractor file1.jpg file2.jpg file3.jpg --pretty
# Process multiple files with wildcards (shell expands wildcards)
indicator-extractor *.jpg --pretty
indicator-extractor images/*.png -o ./output
# Specify output directory with -o flag
indicator-extractor input.jpg -o ./output
# You can also use --output instead of -o
indicator-extractor input.jpg --output ./output --pretty# Run from the project directory (output to same directory as input file)
node src/cli.js input.jpg
# With pretty printing
node src/cli.js input.png --pretty
# With basic content analysis only (no indicator set)
node src/cli.js input.jpg --basic
# Process multiple files
node src/cli.js file1.jpg file2.jpg file3.jpg --pretty
# Process with wildcards (shell expands *.jpg)
node src/cli.js testfiles/*.jpg -o ./output --pretty
# Specify output directory
node src/cli.js input.jpg -o ./output --pretty<input-files...>: Path to input file(s) to process - supports multiple files and wildcards (required)-o, --output <output-dir>: Directory where the JSON output file will be created (optional, defaults to input file directory)-p, --pretty: Pretty print the JSON output (optional, default: false)-b, --basic: Output basic content analysis only, skip Trust Indicator Set generation (optional, default: false)
The CLI supports processing multiple files in a single command. When processing multiple files:
- Each file is processed independently
- A summary is displayed showing total files processed, successful, and failed
- Processing continues even if individual files fail
- Exit code is 0 if at least one file succeeds, 1 if all files fail
Examples:
# Process multiple specific files
indicator-extractor photo1.jpg photo2.jpg photo3.jpg --pretty
# Use wildcards (expanded by your shell)
indicator-extractor *.jpg -o ./output
indicator-extractor images/**/*.png --pretty
# Mix different file types
indicator-extractor photo.jpg document.png image.heif -o ./resultsThe CLI generates different JSON output depending on the mode:
For binary files (images), the CLI generates a single Trust Indicator Set file by default, as defined in ISO 21617-1:
{
"@context": ["https://jpeg.org/jpegtrust"],
"manifests": [
{
"label": "manifest_label",
"claim.v2": { ... },
"claim_signature": { ... },
"assertions": [ ... ]
}
],
"content": { ... },
"metadata": { ... },
"asset_info": {
"alg": "sha256",
"hash": "..."
}
}This is the recommended output format for most use cases as it provides the complete Trust Indicator Set.
For text files, or when using the --basic flag with binary files, a single basic analysis file is generated:
{
"metadata": {
"inputFile": "/absolute/path/to/input.jpg",
"fileName": "input.jpg",
"fileSize": 123456,
"processedAt": "2025-06-20T10:30:00.000Z",
"fileExtension": ".jpg"
},
"content": {
"type": "binary",
"size": 123456,
"note": "Binary file content not displayed"
},
"c2pa": {
"fileFormat": "JPEG",
"hasManifestStore": true,
"manifestCount": 1,
"validationStatus": {
"isValid": true
}
},
"processing": {
"status": "completed",
"version": "1.0.0"
}
}The --basic flag is useful when you only need basic file information and C2PA metadata without the full Trust Indicator Set.
# Run the CLI
npm start
# Run tests
npm test
# Run tests with coverage
npm run test:coverage
# Run tests in watch mode
npm run test:watch
# Lint code
npm run lint
# Fix linting issues
npm run lint:fixThe project includes comprehensive tests using Jest:
- Unit Tests: Test individual utility functions
- Integration Tests: Test the complete CLI workflow
- Error Handling Tests: Verify graceful error handling
- C2PA Tests: Verify processing of the Content Credentials & JPEG Trust Manifests
# Run all tests
npm test
# Run tests with coverage report
npm run test:coverage
# Run tests in watch mode for development
npm run test:watchThe project uses ESLint for code quality and consistency:
# Check for linting issues
npm run lint
# Automatically fix linting issues
npm run lint:fixThe project uses modern ESLint configuration with the following features:
- Modern JavaScript: ES2020 support with async/await
- Node.js Environment: Configured for Node.js development
- Strict Rules: Enforces consistent code style and best practices
- Jest Support: Configured for Jest testing environment
indicator-extractor/
├── src/
│ └── cli.js # Main CLI script
│ └── indicatorSet.js # Create the Trust Indicator Set
│ └── processManifest.js # Process any C2PA/JPEG Trust Manifests
├── testfiles/ # Test files for testing
├── tests/
│ ├── test-helpers.js # Utility routines for tests
│ ├── basic-functionality.test.js # Tests for basic functionality
│ ├── error-handling.test.js # Tests for error handling
│ ├── content-analysis.test.js # Tests for content analysis
│ ├── c2pa-processing.test.js # Tests for C2PA processing
│ ├── setup.js # Jest setup
├── output/ # Output directory for processed files
├── coverage/ # Coverage reports (generated)
├── .github/
│ └── copilot-instructions.md # Copilot custom instructions
├── .gitignore # Git ignore rules
├── eslint.config.js # ESLint configuration
├── jest.config.js # Jest configuration
├── package.json # Project configuration
├── README.md # This file
└── LICENSE # Project license
- Test Environment: Node.js
- Coverage Collection: Collects coverage from
src/**/*.js - Test Pattern: Matches
**/tests/**/*.test.js - Coverage Reports: Text, LCOV, and HTML formats
- Modern Config: Uses the new flat config format
- Node.js Rules: Optimized for Node.js development
- Jest Support: Includes Jest globals for test files
- Strict Standards: Enforces code quality and consistency
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Run tests (
npm test) - Run linting (
npm run lint) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
- Breaking Change: Trust Indicator Set generation is now the default behavior
- Breaking Change: Only a single JSON file is created (indicator set by default, or basic JSON with
--basic) - Added support for processing multiple files in a single command (supports wildcards)
- Changed output directory from positional argument to optional
-oor--outputflag (defaults to input file directory) - Added
--basicflag to generate basic content analysis only (skips indicator set generation) - Removed
--setflag (functionality is now default) - Added summary output when processing multiple files
- Updated all tests and documentation to reflect new behavior
- Initial release
- Comprehensive test suite
- ESLint integration
- Jest testing framework
- Pretty printing support
- Error handling and validation