Catenivo Documentation

English

Catenivo
Français

English

Catenivo
Français

Appearance

Command line ​

The Catenivo CLI runs an .etl project without opening the graphical application. It is suitable for scripts, scheduled workflows and operations integration.

Availability ​

Windows: the desktop installer contains the CLI launcher and can add its directory to the user PATH.

powershell
catenivo.exe --version
catenivo.exe --lang en --help

Linux: the Debian package and AppImage embed the runtime required for subprojects, but do not install the standalone CLI. The Debian package’s /usr/bin/catenivo command starts the desktop application. The Linux contract uses a separate portable dist-cli directory, avoiding a command collision and avoiding duplication of the CLI runtime in desktop packages.

For a Linux CLI copy built from source:

bash
./dist-cli/catenivo --version
./dist-cli/catenivo --lang en --help

Do not replace the desktop /usr/bin/catenivo with this portable binary.

Run a project ​

powershell
catenivo.exe run "C:\\Workflows\\project.etl"

The CLI uses the active version saved in the document unless you explicitly select one with --project-version.

Parameters ​

powershell
catenivo.exe run "C:\\Workflows\\project.etl" `
  --param source_file="C:\\Data\\input.csv" `
  --param distance=25

For a secret:

powershell
$env:CATENIVO_TOKEN = "..."
catenivo.exe run "C:\\Workflows\\project.etl" `
  --param-env api_token=CATENIVO_TOKEN

Rejects and exit codes ​

By default, a workflow can complete with rejected features. Add --fail-on-reject when your scheduler must distinguish this case.

Main codes:

  • 0: workflow completed;
  • 1: execution error;
  • 2: invalid arguments or configuration;
  • 3: completed with rejects and --fail-on-reject;
  • 70: embedded runtime unavailable;
  • 130: cancelled.

Reports and JSON ​

--report writes a final JSON report. --json emits NDJSON events on stdout for machine integration.

Caches ​

The CLI does not use graphical inspection caches and disables inspection operators for its runs. Technical working files can still be used by sorts, joins or other processing that requires them.

For advanced details, refer to the repository’s developer documentation.