Skip to content

CLI

The ai-cdss-cli Typer tool runs the engine from the command line — cohort/patient recommendations and the offline PPF / similarity computations.

pipx install git+https://github.com/dabadav/ai-cdss-cli.git
ai-cdss-cli --help

The reference below is generated from the Typer app itself (scripts/gen_cli_docs.py). The CLI targets the published ai-cdss (v0.3.2), not this refactor branch.

CLI for the AI-CDSS Client.

Usage:

$ ai-cdss-cli [OPTIONS] COMMAND [ARGS]...

Options:

  • -V, -v, --version: Show version and exit.
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • recommend: Generate treatment recommendations for a...
  • compute-metrics: Computes Patient-Protocol Fit (PPF) based...
  • compute-protocol-metrics: Computes Protocol Similarity Metrics based...

ai-cdss-cli recommend

Generate treatment recommendations for a study OR explicit patient list. Use --study-id for a cohort run, or --patient-id for targeted patients.

Usage:

$ ai-cdss-cli recommend [OPTIONS]

Options:

  • -s, --study-id INTEGER: Study cohort ID(s). Repeat to provide multiple integers.
  • -p, --patient-id INTEGER: Explicit patient ID(s). Repeat to provide multiple integers.
  • -n, --n INTEGER: Number of recommendations per patient.
  • -d, --days INTEGER: Number of days to cover in the recommendation.
  • -P, --protocols-per-day INTEGER: Number of protocols per day.
  • -e, --env-file PATH: Path to a .env file with environment variables. [required]
  • --debug: Enable debug mode (no DB writes, return intermediates).
  • --force: Bypass the duplication guard and rerun even when the patient already has prescription_staging rows for the current week. Default behaviour is to skip such patients.
  • --help: Show this message and exit.

ai-cdss-cli compute-metrics

Computes Patient-Protocol Fit (PPF) based on loaded data. Returns the computed PPF with contributions.

Usage:

$ ai-cdss-cli compute-metrics [OPTIONS]

Options:

  • -p, --patient-id INTEGER: Patient ID to compute metrics for. [required]
  • -e, --env-file PATH: Path to a .env file with environment variables.
  • --help: Show this message and exit.

ai-cdss-cli compute-protocol-metrics

Computes Protocol Similarity Metrics based on loaded data. Returns the computed metrics.

Usage:

$ ai-cdss-cli compute-protocol-metrics [OPTIONS]

Options:

  • -e, --env-file PATH: Path to a .env file with environment variables.
  • --help: Show this message and exit.