-
Notifications
You must be signed in to change notification settings - Fork 0
CLI Entry Point
Syed Ibrahim Omer edited this page Apr 13, 2026
·
1 revision
This page documents the CLI wiring: arguments, options, and mode routing.
- Path:
src/cli.py - Console script:
indicators(seepyproject.tomlentry point)
- Define Click command, arguments, and options
- Route execution based on flags:
-
--test→ runtests/run_tests.py -
--profile→ runprofiling/run_profiles.py - otherwise → run
src/indicators.py:run_main(...)
-
When --test is passed:
- The runner
tests.run_tests.main(...)is invoked viaasyncio.run(...) - The process exits with the runner’s exit code
When --profile is passed:
- The runner
profiling.run_profiles.main(...)is invoked - The CLI temporarily replaces
sys.argvto pass suite/mode/scenario arguments
When neither --test nor --profile is passed:
- At least one ticker must be provided, or Click raises a usage error
Related pages:
- Getting Started
- CLI Reference
- Configuration & Templates
- Indicators (Overview)
- Output Formats
- Advanced Usage
- Troubleshooting
- Pipeline
- CLI Parsing
- Data Source (Yahoo Finance)
- Source Data Deep Dive
- Schema Normalization
- Data Shape Invariants
- Output Writing
- Write Output Deep Dive
- Config Resolution
- Polars Engine
- Source Modules
- Testing
- Performance
- Indicators Engine
- Reproducibility