Skip to content

geosync_cli_reference.md

Latest commit

 

History

History
181 lines (124 loc) · 5.13 KB

geosync_cli_reference.md

File metadata and controls

181 lines (124 loc) · 5.13 KB
owner dx@geosync
review_cadence quarterly
last_reviewed 2026-01-01

GeoSync CLI Command Reference

This file is auto-generated by tools/docs/generate_geosync_cli_docs.py. Do not edit manually.

Global usage

Usage: cli [OPTIONS] COMMAND [ARGS]...

  GeoSync orchestration CLI.

Options:
  --templates-dir DIRECTORY  Directory containing YAML configuration templates.
  --help                     Show this message and exit.

Commands:
  backtest     Execute a simple vectorized backtest.
  completion   Generate shell completion snippet for the requested shell.
  exec         Evaluate the latest signal and persist it to disk.
  ingest       Run data ingestion and register the produced artifact.
  materialize  Run data ingestion and register the produced artifact.
  optimize     Perform a brute-force search across a parameter grid.
  report       Aggregate JSON artifacts into a markdown summary.
  serve        Evaluate the latest signal and persist it to disk.
  train        Perform a brute-force search across a parameter grid.

ingest

--help

Usage: cli ingest [OPTIONS]

  Run data ingestion and register the produced artifact.

Options:
  --config PATH           Path to ingest YAML config.
  --generate-config       Write the default ingest config template.
  --template-output PATH  Destination for generated template.
  --help                  Show this message and exit.

Examples

  • geosync-cli ingest --generate-config --template-output configs/ingest.yaml
  • geosync-cli ingest --config configs/ingest.yaml

materialize

Alias for ingest.

--help

Usage: cli materialize [OPTIONS]

  Run data ingestion and register the produced artifact.

Options:
  --config PATH           Path to ingest YAML config.
  --generate-config       Write the default ingest config template.
  --template-output PATH  Destination for generated template.
  --help                  Show this message and exit.

Examples

  • geosync-cli materialize --generate-config --template-output configs/materialize.yaml
  • geosync-cli materialize --config configs/materialize.yaml

backtest

--help

Usage: cli backtest [OPTIONS]

  Execute a simple vectorized backtest.

Options:
  --config PATH                   Path to backtest YAML config.
  --generate-config               Write the default backtest config template.
  --template-output PATH          Destination for generated template.
  --output-format, --output [table|jsonl|parquet]
                                  Render results in the requested format in
                                  addition to the persisted artifact.
  --help                          Show this message and exit.

Examples

  • geosync-cli backtest --generate-config --template-output configs/backtest.yaml
  • geosync-cli backtest --config configs/backtest.yaml --output jsonl

train

Alias for optimize.

--help

Usage: cli train [OPTIONS]

  Perform a brute-force search across a parameter grid.

Options:
  --config PATH                   Path to optimization YAML config.
  --generate-config               Write the default optimize config template.
  --template-output PATH          Destination for generated template.
  --output-format, --output [table|jsonl|parquet]
                                  Render results in the requested format in
                                  addition to the persisted artifact.
  --help                          Show this message and exit.

Examples

  • geosync-cli train --generate-config --template-output configs/train.yaml
  • geosync-cli train --config configs/train.yaml --output table

serve

Alias for exec.

--help

Usage: cli serve [OPTIONS]

  Evaluate the latest signal and persist it to disk.

Options:
  --config PATH                   Path to exec YAML config.
  --generate-config               Write the default exec config template.
  --template-output PATH          Destination for generated template.
  --output-format, --output [table|jsonl|parquet]
                                  Render results in the requested format in
                                  addition to the persisted artifact.
  --help                          Show this message and exit.

Examples

  • geosync-cli serve --generate-config --template-output configs/serve.yaml
  • geosync-cli serve --config configs/serve.yaml --output jsonl

report

--help

Usage: cli report [OPTIONS]

  Aggregate JSON artifacts into a markdown summary.

Options:
  --config PATH                   Path to report YAML config.
  --generate-config               Write the default report config template.
  --template-output PATH          Destination for generated template.
  --output-format, --output [table|jsonl|parquet]
                                  Render results in the requested format in
                                  addition to the persisted artifact.
  --help                          Show this message and exit.

Examples

  • geosync-cli report --generate-config --template-output configs/report.yaml
  • geosync-cli report --config configs/report.yaml --output table