Getting Started

Getting Started

Install

Using pip:

pip install indicators-cli

Using uv:

uv pip install indicators-cli

Verify:

indicators --version

Your first run

Default behavior is 5-year period and daily timeframe.

indicators AAPL

Try a different period/timeframe:

indicators AAPL -p 2y -t 1wk

Write to a specific location:

indicators AAPL -f parquet -d ./output -o aapl.parquet

How it works (high level)

1. Fetch OHLCV data (Yahoo Finance via yfinance)
2. Compute indicators (Polars)
3. Write enriched dataset to disk (CSV/Parquet/JSON/XLSX/AVRO)

Related pages:

• CLI Reference
• Indicators (Overview)
• Output Formats