Command Details

qalita --ui

Starts the local web UI for the CLI.

Configuration can be provided via flags or environment variables. See Environment Variables.

Parameters:

• --host (or QALITA_WORKER_UI_HOST): Host interface to listen on (default: localhost)
• --port (or QALITA_WORKER_UI_PORT): Port to listen on (default: 7070)

Environment:

• QALITA_WORKER_UI=true enables the local UI
• QALITA_WORKER_UI_HOST=localhost
• QALITA_WORKER_UI_PORT=7070

Example:

Linux/macOS

qalita --ui --host localhost --port 7070

Windows (PowerShell)

python -m qalita --ui --host localhost --port 7070

qalita worker

Allows you to:

• Register a worker on the platform
• Get information about your local worker
• Run a pack on a source
• List jobs (past and upcoming)

qalita worker login

Parameters:

• name: Worker name
• mode: Worker mode (job/worker)
• token: API token provided by the platform
• url: Backend API URL of the platform

qalita worker login registers your local worker on the platform. This allows you to run jobs or schedule executions. You must have configured your agent with:

• QALITA_WORKER_ENDPOINT=backend_api_url
• QALITA_WORKER_TOKEN=api_token

You can obtain your token from the web interface or via an OAUTH2 call to the /users/signin endpoint.

qalita worker run

Parameters: The options below are defined at the agent group level and/or the run command level:

Worker group (applicable to all subcommands):

• -n, --name (or QALITA_WORKER_NAME)
• -m, --mode (or QALITA_WORKER_MODE) — values: job | worker
• -t, --token (or QALITA_WORKER_TOKEN)
• -u, --url (or QALITA_WORKER_ENDPOINT)

Worker run command:

• -s, --source-id (or QALITA_WORKER_JOB_SOURCE): Source ID
• -sv, --source-version (or QALITA_WORKER_JOB_SOURCE_VERSION): Source version (default: latest)
• -t, --target-id: Target source ID (optional)
• -tv, --target-version: Target source version (optional)
• -p, --pack-id (or QALITA_WORKER_JOB_PACK): Pack ID
• -pv, --pack-version (or QALITA_WORKER_JOB_PACK_VERSION): Pack version (default: latest)

qalita worker run

Works in two modes:

Job

The worker runs according to the given configuration:

• -p: pack_id (see qalita pack list). Your pack must be published to have an ID.
• -s: source_id (see qalita source list). Your source must be published to have an ID.

Worker

The worker waits for an order from the platform, then acts as in job mode.

info

Note: This mode runs indefinitely, you can adjust the pooling interval by editing the ENV variable : WORKER_POLLING_INTERVAL

qalita worker joblist

Lists the worker's jobs on the platform.

Linux/macOS

qalita worker joblist

Windows (PowerShell)

python -m qalita worker joblist

qalita worker info

Displays information about the local worker (name, mode, backend URL, registered agent ID).

Linux/macOS

qalita worker info

Windows (PowerShell)

python -m qalita worker info

qalita pack

The qalita pack command allows you to:

• Initialize a new pack
• List available packs
• Validate a pack
• Run a pack locally
• Publish a pack version on the platform

qalita pack init

Parameters:

• --name: Pack name

Initializes a new pack. You must define a name; a folder will be created with this name. You can set the name via a command-line parameter or via the environment variable QALITA_PACK_NAME=my-super-pack.

Directory structure created:

./`pack-name`_pack/
    /run.sh             # Entrypoint file that will be run with qalita worker run
    /README.md          # Documentation file
    /properties.yaml    # Properties file that contains properties about the pack
    /main.py            # (pack specific) The main script (you can run your pack with whatever language you choose)
    /config.json        # (pack specific) The config file of your pack, you can use it to set any configurations you like
    /requirements.txt   # (pack specific) The requirements file that is run inside the run.sh

qalita pack list

Parameters:

• You must be logged in via qalita worker login

Lists all packs available on the QALITA platform.

qalita pack run

Parameters:

• --name: Pack name

Runs your locally configured pack.

qalita pack validate

Parameters:

• --name: Pack name

Validates your locally configured pack.

qalita pack push

Parameters:

• --name: Pack name

Publishes your locally configured pack.

qalita source

The qalita source command allows you to:

• Add a new source to your local configuration
• List your local sources from the sources-conf.yml file
• Publish your local sources from the sources-conf.yml file
• Validate your configuration file sources-conf.yml

Note: By default, the sources-conf.yml file is stored in ~/.qalita/sources-conf.yml. Set the QALITA_HOME variable to customize the path.

qalita source add

This command guides you to add a new source in sources-conf.yaml. It takes no parameters; follow the successive prompts:

• Prompt 1: Source name
• Prompt 2: Source type
• Prompt 3: Depends on the source type
  • Case: type = file: source path
  • Case: type = database: host / port / username / password / database
• Prompt 4: Description
• Prompt 5: Is the source a reference? [bool] (default: false)
• Prompt 6: Is the source sensitive? [bool] (default: false)
• Prompt 7: Visibility (private, internal, public) (default: private)

At the end, the CLI checks the accessibility of the source based on the configuration and type (validate_source). To complete the source registration on the platform, publish it with: qalita source push

qalita source validate

Utility command to validate your sources-conf.yaml file.

qalita source list

Parameters: You must have a sources-conf.yaml file containing the source configuration.

Example:

version: 1
sources:
- config:
    path: /home/user/data_dir
  description: Folder containing csv files
  name: my_csv_files
  owner: user
  reference: false
  visibility: private
  sensitive: false
  type: file

In this example: General keys

Key	Type	Description
version	int	Configuration file version
sources	list	List of sources

Source keys

Key	Type	Description
name	string	Source name
description	string	Source description
owner	string	Source owner
type	string	Source type
config	dict	Source configuration
visibility	string	Visibility private/internal/public
reference	bool	Is the source a reference source?
sensitive	bool	Does the source contain sensitive data?

qalita source push

Publishes your sources to the platform.

warning

If you want to run a pack on your source, you will first need to push your source to the platform. It will give you a source id with which you can run your pack on.

Parameters:

• --skip-validate: Does not validate sources locally before publishing. Equivalent to the ENV QALITA_SKIP_VALIDATE=true.
  • Warning: This may push unreachable/invalid sources.
  • Note: This flag is sometimes called "skip-verify" in some contexts. The exact name in the CLI is --skip-validate.

Behavior:

• Loads the local configuration (~/.qalita/sources-conf.yml by default) and, unless --skip-validate is used, performs local validation.
• Queries the platform and:
  • Updates an existing source if it is already published (visibility, description, sensitive, reference) and synchronizes the local id if needed.
  • Publishes a new source otherwise; asks for confirmation if visibility is public.
• On success, writes the returned id to the local configuration file.

Examples: Simple publish:

Linux/macOS

qalita source push

Windows (PowerShell)

python -m qalita source push

Force publish without local validation:

Linux/macOS

qalita source push --skip-validate

Windows (PowerShell)

python -m qalita source push --skip-validate

Use environment variable (equivalent to --skip-validate):

Linux/macOS

QALITA_SKIP_VALIDATE=1 qalita source push

Windows (PowerShell)

$env:QALITA_SKIP_VALIDATE='1'; qalita source push