MovEq
Overview G Core Inequality S Composite Scoring H Harmonization DataFrames CLI Reference
Docs / Core Engines / CLI Reference

Command-Line Interface Reference

The moveq CLI is a zero-configuration command-line binary installed with pip install "moveq[cli]". It enables transit engineers and data teams to evaluate inequality metrics on CSV files, compute JSON composite scores, and validate catalogue schemas inside automated pipelines.

1. moveq gini

Calculates the population-weighted Gini coefficient directly from columns in a CSV file:

Terminal bash / zsh 
moveq gini data.csv --value trips_per_capita --weight population
Flag Type Description
csv_file Path Positional Path to input CSV file.
--value str Required Header name of the service/resource column in the CSV.
--weight str Required Header name of the population/weight column in the CSV.

2. moveq palma

Calculates the continuous boundary Palma ratio (Top 10% / Bottom 40%):

Terminal bash 
moveq palma data.csv --value departures --weight pop_count

3. moveq ci

Calculates the Wagstaff Concentration Index against a deprivation rank column:

Terminal bash 
moveq ci data.csv --value bus_trips --rank deprivation_decile --weight pop_count

4. moveq score

Evaluates a composite accessibility score from inline JSON strings or configuration files:

Terminal Inline Arguments 
# Inline JSON strings with dynamic dropping
moveq score \
  --terms '{"buffer": 0.85, "evening": 0.60}' \
  --weights '{"buffer": 0.50, "evening": 0.30, "night": 0.20}'

# JSON output for API pipelines
moveq score --config audit_config.json --json

5. moveq catalogue validate

Validates a cross-country harmonization JSON schema in CI/CD build steps:

Terminal CI/CD Step 
moveq catalogue validate country_catalogue.json

# Exit codes:
# 0 = Valid and fully specified
# 1 = Unmapped base sections or invalid replacement syntax