Skip to content

Latest commit

 

History

History
88 lines (64 loc) · 3.19 KB

README.md

File metadata and controls

88 lines (64 loc) · 3.19 KB

PyPI Downloads Release)

tastytrade-cli

An easy-to-use command line interface for Tastytrade!

Peek2024-12-0322-18-ezgif com-speed

Installation

$ pip install tastytrade-cli

Warning

The CLI is still under active development. Please report any bugs, and contributions are always welcome!

Usage

Available commands:

tt option              view chains, buy or sell equities and futures options
tt pf (portfolio)      view and close positions, check margin and analyze BP usage
tt trade               buy or sell stocks/ETFs, crypto, and futures

Unavailable commands pending development:

tt order               view, replace, and cancel orders
tt wl (watchlist)      view current prices and other data for symbols in your watchlists

For more options, run tt --help or tt <subcommand> --help.

Configuration

Many aspects of the CLI's behavior can be customized using the ttcli.cfg file generated upon the first usage of the CLI. The file is located in your OS's home directory followed by the path .config/ttcli/ttcli.cfg. If you don't know where that is, you can just run python -c "from ttcli.utils import config_path; print(config_path)".

The default configuration file contains lots of options along with explanations of what they do.

Shell completion

Bash

Add this line to your .bashrc:

eval "$(_TT_COMPLETE=bash_source tt)"
Zsh

Add this line to your .zshrc:

eval "$(_TT_COMPLETE=zsh_source tt)"
Fish

Add this to ~/.config/fish/completions/tt.fish

_TT_COMPLETE=fish_source tt | source

Development/Contributing

This project includes a number of helpers in the Makefile to streamline common development tasks. Make sure you already have uv installed!

Creating a virtualenv for development:

$ make install

It's usually a good idea to make sure you're passing tests locally before submitting a PR:

$ make lint

If you have a feature suggestion, find a bug, or would like to contribute, feel free to open an issue or create a pull request.

Disclaimer

tastyworks and tastytrade are not affiliated with the makers of this program and do not endorse this product. This program does not provide investment, tax, or legal advice. Stock trading involves risk and is not suitable for all investors. Options involve risk and are not suitable for all investors as the special risks inherent to options trading may expose investors to potentially significant losses. Futures and futures options trading is speculative and is not suitable for all investors. Cryptocurrency trading is speculative and is not suitable for all investors.