Kinetiqo Logo Kinetiqo
GitHub
Terminal Automation

Kinetiqo Command-Line Interface (CLI) Manual

Complete reference manual for all command-line operations, sync triggers, and database flags.

CLI Invocation Syntax

Execute commands directly via Python or inside running Docker containers:

syntax overview 
# Direct Python invocation
python src/kinetiqo.py [GLOBAL OPTIONS] COMMAND [COMMAND OPTIONS]

# Docker container invocation
docker exec -it kinetiqo python src/kinetiqo.py [GLOBAL OPTIONS] COMMAND [COMMAND OPTIONS]

Global Options

Global options apply to all subcommands and override configuration environment variables:

Option Short / Alias Allowed Values Description
--database-type --database, -d postgresql, mysql, firebird Override the target SQL database engine for this command execution.
--log-level - DEBUG, INFO, WARNING, ERROR, CRITICAL Set log verbosity for CLI & Flask backend. Default: INFO.
--help - - Show help message and exit.

1. kinetiqo web

Web Dashboard Server

Starts the async Flask web dashboard interface. Seeds athlete profile data from Strava automatically on startup.

web command options 
python src/kinetiqo.py web [OPTIONS]

Options:
  --port INTEGER       Port to run the web server on (default: 4444 / 5000 in container).
  --host TEXT          Host IP address to bind to (default: 0.0.0.0).
  -d, --database-type  Override database backend (postgresql, mysql, firebird).
  --help               Show command help message and exit.

Examples:

# Start web dashboard on default host & port
python src/kinetiqo.py web

# Start web dashboard on port 8080 with PostgreSQL database
python src/kinetiqo.py --database-type postgresql web --port 8080 --host 127.0.0.1

2. kinetiqo sync

Strava Synchronization

Synchronizes activity data between the Strava API and your local SQL database. Supports incremental fast syncs and full audit reconciliations.

sync command options 
python src/kinetiqo.py sync [OPTIONS]

Options:
  -q, --fast-sync                 Perform incremental fast sync (fetches only new activities since last DB sync).
  -f, --full-sync                 Perform comprehensive full audit (audits entire history & reconciles deletions).
  -p, --period TEXT               Limit full sync scope (e.g. '7d' for 7 days, '2w' for 2 weeks, '1m' for 1 month).
  -U, --update-strava-description Update Strava activity descriptions (true/false, 1/0, yes/no). Default: true.
  --enable-strava-cache           Enable disk caching of raw Strava API HTTP responses.
  --cache-ttl INTEGER             Cache TTL in minutes (default: 60).
  --clear-cache                   Clear cached Strava responses before executing sync.
  -d, --database-type             Override database backend (postgresql, mysql, firebird).
  --help                          Show command help message and exit.

Examples:

# Fast incremental sync (ideal for frequent cron jobs)
python src/kinetiqo.py sync --fast-sync

# Comprehensive full audit sync with Strava description updates
python src/kinetiqo.py sync --full-sync --update-strava true

# Full sync limited to the last 14 days with response caching enabled
python src/kinetiqo.py sync --full-sync --period 2w --enable-strava-cache --cache-ttl 120

3. kinetiqo flightcheck

Health Check

Performs a diagnostic health check verifying database availability, credentials, and table schema integrity. Returns exit code 0 on success or 1 on failure (useful for Docker container healthprobes & CI/CD pipelines).

# Test database health
python src/kinetiqo.py flightcheck

# Test health against MySQL target
python src/kinetiqo.py --database-type mysql flightcheck

4. kinetiqo version

Version Info

Outputs current Kinetiqo release version, Python runtime version, and system details.

python src/kinetiqo.py version