CLI : Command Line

The Chloros CLI provides powerful command-line access to the Chloros image processing engine, enabling automation, scripting, and headless operation for your imaging workflows.

Key Features

  • 🚀 Automation - Script batch processing of multiple datasets

  • 🔗 Integration - Embed in existing workflows and pipelines

  • 💻 Headless Operation - Run without GUI

  • 🌍 Multi-Language - Support for 38 languages

  • Parallel Processing - Dynamic Compute Adaptation automatically optimizes for your hardware

Requirements

Requirement
Details

Operating System

Windows 10/11 (64-bit), Linux x86_64 (amd64), Linux arm64 (NVIDIA Jetson JetPack 6)

Memory

8GB RAM minimum (16GB recommended)

Internet

Required for license activation

Disk Space

Varies by project size

circle-exclamation

Quick Start

Installation

Windows

The CLI is automatically included with the Chloros installer:

  1. Download and run Chloros Installer.exe

  2. Complete the installation wizard

  3. CLI installed to: C:\Program Files\Chloros\resources\cli\chloros-cli.exe

circle-check

Linux

Install the .deb package for your architecture:

For detailed Linux setup, see Linux Installation.

First-Time Setup

Before using the CLI, activate your Chloros+ license:

Windows:

Linux:

Basic Usage

Process a folder with default settings:

Windows:

Linux:


Command Reference

General Syntax


Commands

process - Process Images

Process images in a folder with calibration.

Syntax:

Examples:

Process Command Options

Option
Type
Default
Description

<input-folder>

Path

Required

Folder containing RAW/JPG multispectral images

-o, --output

Path

Same as input

Output folder for processed images

-n, --project-name

String

Auto-generated

Custom project name

--vignette

Flag

Enabled

Enable vignette correction

--no-vignette

Flag

-

Disable vignette correction

--reflectance

Flag

Enabled

Enable reflectance calibration

--no-reflectance

Flag

-

Disable reflectance calibration

--ppk

Flag

Disabled

Apply PPK corrections from .daq light sensor data

--format

Choice

TIFF (16-bit)

Output format: TIFF (16-bit), TIFF (32-bit, Percent), PNG (8-bit), JPG (8-bit)

--min-target-size

Integer

Auto

Minimum target size in pixels for calibration panel detection

--target-clustering

Integer

Auto

Target clustering threshold (0-100)

--debayer

Choice

standard

Debayer method: standard or texture-aware (Chloros+ only)

--target, --targets

Flag

Disabled

Only search for calibration targets in a "target" or "targets" subfolder (speeds up processing)

--indices

List

None

Vegetation indices to calculate (e.g., --indices NDVI NDRE GNDVI)

--exposure-pin-1

String

None

Lock exposure for camera model (Pin 1)

--exposure-pin-2

String

None

Lock exposure for camera model (Pin 2)

--recal-interval

Integer

Auto

Recalibration interval in seconds

--timezone-offset

Integer

0

Timezone offset in hours


login - Authenticate Account

Login with your Chloros+ credentials to enable CLI processing.

Syntax:

Example:

circle-exclamation

Output:


logout - Clear Credentials

Clear stored credentials and logout from your account.

Syntax:

Example:

Output:

circle-info

SDK Users: The Python SDK also provides a programmatic logout() method for clearing credentials within Python scripts. See the Python SDK documentation for details.


status - Check License Status

Display current license and authentication status.

Syntax:

Example:

Output:


export-status - Check Export Progress

Monitor Thread 4 export progress during or after processing.

Syntax:

Example:

Use Case: Call this command while processing is running to check export progress.


language - Manage Interface Language

View or change the CLI interface language.

Syntax:

Examples:

Supported Languages (38 Total)

Code
Language
Native Name

en

English

English

es

Spanish

Español

pt

Portuguese

Português

fr

French

Français

de

German

Deutsch

it

Italian

Italiano

ja

Japanese

日本語

ko

Korean

한국어

zh

Chinese (Simplified)

简体中文

zh-TW

Chinese (Traditional)

繁體中文

ru

Russian

Русский

nl

Dutch

Nederlands

ar

Arabic

العربية

pl

Polish

Polski

tr

Turkish

Türkçe

hi

Hindi

हिंदी

id

Indonesian

Bahasa Indonesia

vi

Vietnamese

Tiếng Việt

th

Thai

ไทย

sv

Swedish

Svenska

da

Danish

Dansk

no

Norwegian

Norsk

fi

Finnish

Suomi

el

Greek

Ελληνικά

cs

Czech

Čeština

hu

Hungarian

Magyar

ro

Romanian

Română

uk

Ukrainian

Українська

pt-BR

Brazilian Portuguese

Português Brasileiro

zh-HK

Cantonese

粵語

ms

Malay

Bahasa Melayu

sk

Slovak

Slovenčina

bg

Bulgarian

Български

hr

Croatian

Hrvatski

lt

Lithuanian

Lietuvių

lv

Latvian

Latviešu

et

Estonian

Eesti

sl

Slovenian

Slovenščina

circle-check

set-project-folder - Set Default Project Folder

Change the default project folder location (shared with GUI on Windows).

Syntax:

Examples:


get-project-folder - Show Project Folder

Display the current default project folder location.

Syntax:

Example:

Output:


reset-project-folder - Reset to Default

Reset the project folder to the default location.

Syntax:


selftest - Run System Diagnostics

Run 7 diagnostic checks to verify your system configuration.

Syntax:

Diagnostics performed:

  1. Version check

  2. Port availability (5000)

  3. Backend startup

  4. API connectivity test

  5. System info and GPU detection

  6. Denoiser models verification

  7. CUDA availability check

circle-info

Useful for troubleshooting: Run selftest after installation to verify your system is configured correctly, especially on Linux/Jetson where GPU and CUDA setup may need verification.


update - Check for Updates (Linux Only)

Check for and install CLI updates on Linux systems.

Syntax:

Option
Description

--check

Only check for updates, don't install

circle-info

This command is available on Linux only. On Windows, updates are delivered through the installer.


Global Options

These options apply to all commands:

Option
Type
Default
Description

--backend-exe

Path

Auto-detected

Path to backend executable

--port

Integer

5000

Backend API port number

--restart

Flag

-

Force restart backend (kills existing processes)

--version

Flag

-

Show version information and exit

--help

Flag

-

Show help information and exit

circle-info

Backend auto-detection: The --backend-exe path is auto-detected per platform:

  • Windows: C:\Program Files\MAPIR\Chloros\resources\backend\chloros-backend.exe

  • Linux (.deb): /usr/lib/chloros/chloros-backend

  • Linux (manual): /opt/mapir/chloros/backend/chloros-backend

Example with Global Options:

Windows:

Linux:


Processing Settings Guide

Parallel Processing & Dynamic Compute Adaptation

Chloros 1.1.0 includes Dynamic Compute Adaptation — the processing engine automatically detects your hardware and selects the optimal strategy:

Platform
Strategy
Workers
Pipeline
Notes

Jetson Nano 8GB

GPU_SINGLE

1

tiled_gpu

Memory-efficient, serialized

Jetson Orin NX 16GB

GPU_PARALLEL

3

fused_gpu

Concurrent GPU processing

Desktop with 8GB GPU

GPU_SINGLE

3

tiled_gpu

Good desktop performance

Desktop with 12GB+ GPU

GPU_PARALLEL

3-4

fused_gpu

Optimal desktop performance

CPU-only system

CPU_PARALLEL

cores - 1

cpu_fallback

No GPU required

circle-check

Debayer Methods

Method
CLI Flag
Quality
Speed
License

Standard (Fast, Medium Quality)

--debayer standard

Good

Fast

Free / Chloros+

Texture Aware (Slow, Highest Quality)

--debayer texture-aware

Highest

Slow

Chloros+ only

The default debayer method is Standard. The Texture Aware method uses an AI/ML denoising model for the highest quality output but requires a Chloros+ license and an NVIDIA GPU.

Vignette Correction

What it does: Corrects light falloff at image edges (darker corners common in camera imagery).

  • Enabled by default - Most users should keep this enabled

  • Use --no-vignette to disable

circle-check

Reflectance Calibration

Converts raw sensor values to standardized reflectance percentages using calibration panels.

  • Enabled by default - Essential for vegetation analysis

  • Requires calibration target panels in images

  • Use --no-reflectance to disable

circle-info

Requirements: Ensure calibration panels are properly exposed and visible in your images for accurate reflectance conversion.

PPK Corrections

What it does: Applies Post-Processed Kinematic corrections using DAQ-A-SD log data for improved GPS accuracy.

  • Disabled by default

  • Use --ppk to enable

  • Requires .daq files in project folder from MAPIR DAQ-A-SD light sensor.

Output Formats

Format
Bit Depth
File Size
Best For

TIFF (16-bit)

16-bit integer

Large

GIS analysis, photogrammetry (recommended)

TIFF (32-bit, Percent)

32-bit float

Very Large

Scientific analysis, research

PNG (8-bit)

8-bit integer

Medium

Visual inspection, web sharing

JPG (8-bit)

8-bit integer

Small

Quick preview, compressed output


Automation & Scripting

PowerShell Batch Processing (Windows)

Process multiple dataset folders automatically on Windows:

Windows Batch Script (Windows)

Simple loop for batch processing on Windows:

Bash Batch Processing (Linux)

Process multiple dataset folders on Linux:

Python Automation Script (Cross-Platform)

Advanced automation with error handling (works on Windows and Linux):


Processing Workflow

Standard Workflow

  1. Input: Folder containing RAW/JPG image pairs

  2. Discovery: CLI auto-scans for supported image files

  3. Processing: Parallel mode scales to your CPU cores (Chloros+)

  4. Output: Creates camera-model subfolders with processed images

Example Output Structure

Processing Time Estimates

Typical processing times for 100 images (12MP each):

Platform
Mode
Estimated Time
Notes

Desktop 12GB+ GPU

GPU_PARALLEL

5-10 min

Fastest option

Desktop 8GB GPU

GPU_SINGLE

10-15 min

Good performance

Jetson Orin NX 16GB

GPU_PARALLEL

15-25 min

Edge compute

Jetson Nano 8GB

GPU_SINGLE

30-60 min

Memory-constrained

CPU-only

CPU_PARALLEL

20-40 min

No GPU required

circle-info

Performance Tip: Processing time varies based on image count, resolution, debayer method, and hardware. Texture Aware debayer takes significantly longer than Standard. See Dynamic Compute Adaptation for details.


Troubleshooting

CLI Not Found

Windows Error:

Windows Solutions:

  1. Verify installation location:

  1. Use full path if not in PATH:

  1. Add to PATH manually:

    • Open System Properties → Environment Variables

    • Edit PATH variable

    • Add: C:\Program Files\Chloros\resources\cli

    • Restart terminal

Linux Error:

Linux Solutions:

  1. Verify installation:

  1. Reload your shell:

  1. Check permissions:


Backend Failed to Start

Error:

Solutions:

  1. Check if backend already running (close it first)

  2. Check firewall is not blocking (Windows) or check port availability (Linux: lsof -i :5000)

  3. Try different port:

  1. Force restart backend:

  1. On Linux, check backend executable exists:


License / Authentication Issues

Error:

Solutions:

  1. Verify you have an active Chloros+ subscription

  2. Login with your credentials:

  1. Check license status:

  1. Contact support: info@mapir.camera


No Images Found

Error:

Solutions:

  1. Verify folder contains supported formats (.RAW, .TIF, .JPG)

  2. Check folder path is correct (use quotes for paths with spaces)

  3. Ensure you have read permissions for the folder

  4. Check file extensions are correct


Processing Stalls or Hangs

Solutions:

  1. Check available disk space (ensure enough for output)

  2. Close other applications to free memory

  3. Reduce image count (process in batches)


Port Already in Use

Error:

Solutions:

Windows:

Linux:


FAQ

Q: Do I need a license for the CLI?

A: Yes! The CLI requires a paid Chloros+ license.

  • ❌ Standard (free) plan: CLI disabled

  • ✅ Chloros+ (paid) plans: CLI fully enabled

Subscribe at: https://cloud.mapir.camera/pricingarrow-up-right


Q: Can I use the CLI on a server without GUI?

A: Yes! The CLI runs completely headless. This is the primary use case on Linux.

Windows Server:

  • Windows Server 2016 or later

  • Visual C++ Redistributable installed

Linux Server:

  • Ubuntu 20.04+ / Debian 11+ (amd64) or JetPack 6 (arm64)

  • Install via .deb package

Both platforms:

  • 8GB RAM minimum (16GB recommended)

  • One-time license activation: chloros-cli login user@example.com 'password'


Q: Where are processed images saved?

A: By default, processed images are saved in the same folder as input in camera-model subfolders (e.g., Survey3N_RGN/).

Use -o option to specify a different output folder:


Q: Can I process multiple folders at once?

A: Not directly in one command, but you can use scripting to process folders sequentially. See Automation & Scripting section.


Q: How do I save CLI output to a log file?

PowerShell:

Batch:

Linux Bash:


Q: What happens if I press Ctrl+C during processing?

A: The CLI will:

  1. Stop processing gracefully

  2. Shut down the backend

  3. Exit with code 130

Partially processed images may remain in the output folder.


Q: Can I automate CLI processing?

A: Absolutely! The CLI is designed for automation. See Automation & Scripting for PowerShell (Windows), Batch (Windows), Bash (Linux), and Python (cross-platform) examples.


Q: How do I check the CLI version?

A:

Output:


Getting Help

Command-Line Help

View help information directly in the CLI:

Support Channels


Complete Examples

Example 1: Basic Processing

Process with default settings (vignette, reflectance):

Windows:

Linux:


Example 2: High-Quality Scientific Output

32-bit float TIFF:

Windows:

Linux:


Example 3: Fast Preview Processing

8-bit PNG without calibration for quick review:

Windows:

Linux:


Example 4: PPK-Corrected Processing

Apply PPK corrections with reflectance:

Windows:

Linux:


Example 5: Custom Output Location

Process to a different location with specific format:

Windows:

Linux:


Example 6: Authentication Workflow

Complete authentication flow (same on all platforms):


Example 7: Multi-Language Usage

Change interface language (same on all platforms):

Last updated