TenorTUI

A terminal UI for browsing stock options chains. Live quotes, full options chains with Greeks, named watchlists, pluggable data providers — all in your terminal.

Documentation, screenshots, and feature walkthrough: https://jayravaliya.com/tenor-tui/

Install

pipx install tenor-tui     # recommended
pip install tenor-tui      # alternative

Then run tenortui.

Requires Python 3.11+. See Installation for from-source setup and provider configuration.

Develop

git clone https://github.com/jayrav13/tenor-tui.git
cd tenor-tui
poetry install --with docs
pre-commit install && pre-commit install --hook-type pre-push
poetry run tenortui

Common commands:

poetry run python -m pytest -v        # tests
poetry run ruff check src/ tests/     # lint
poetry run ruff format src/ tests/    # format
make docs-serve                       # preview docs locally
make snapshots && make demos          # regenerate UI screenshots/GIFs

The full developer guide and contribution flow live in CLAUDE.md.

Contribute

Open an issue first (a checkbox-list of success criteria helps reviewers). Branch off main with fix/<issue-number>-<short-desc>, reference the issue in your commit messages (Closes #N or Refs #N), and update the docs surfaces called out in CLAUDE.md's Documentation Sync table.

Every PR must add a CHANGELOG.md entry under [Unreleased] (CI enforces this). Version bumps trigger an automatic PyPI release on merge.

License

MIT.