tickrs README

The project's README from github.com/tarkah/tickrs. As one markdown file: README.md.

tick-rs

Actions Status

Realtime ticker data in your terminal 📈 Built with Rust. Data sourced from Yahoo! Finance.

Installation

Binary

Download the latest release for your platform

Cargo

cargo install tickrs

Arch Linux

pacman -S tickrs

Homebrew

brew tap tarkah/tickrs
brew install tickrs

Config File

See wiki entry

CLI Usage

tickrs
Realtime ticker data in your terminal 📈

USAGE:
    tickrs [FLAGS] [OPTIONS]

FLAGS:
    -p, --enable-pre-post    Enable pre / post market hours for graphs
    -h, --help               Prints help information
        --hide-help          Hide help icon in top right
        --hide-prev-close    Hide previous close line on 1D chart
        --hide-toggle        Hide toggle block
        --show-volumes       Show volumes graph
    -x, --show-x-labels      Show x-axis labels
        --summary            Start in summary mode
        --trunc-pre          Truncate pre market graphing to only 30 minutes prior to markets opening
    -V, --version            Prints version information

OPTIONS:
    -c, --chart-type <chart-type>              Chart type to start app with [default: line] [possible values: line,
                                               candle, kagi]
    -s, --symbols <symbols>...                 Comma separated list of ticker symbols to start app with
    -t, --time-frame <time-frame>              Use specified time frame when starting program and when new stocks are
                                               added [default: 1D] [possible values: 1D, 1W, 1M, 3M, 6M, 1Y, 5Y]
    -i, --update-interval <update-interval>    Interval to update data from API (seconds) [default: 1]

Windows

Use Windows Terminal to properly display this app.

Acknowledgments

tickrs (tarkah/tickrs)

Searching Database…

1.7K ·GitHub
Tickrs
What is this?tickrs shows realtime stock ticker data in your terminal, built in Rust, with quotes sourced from Yahoo! Finance.
Is this a website or desktop app, or does it run in my terminal?It runs entirely in the terminal as a TUI (text user interface) app, built on the tui-rs library for Rust.
Do I need an account or API key to get the stock data?No extra setup: quotes come straight from Yahoo! Finance, and the README mentions no account, API key, or other prerequisites.
Does it run the same on Windows?Yes, but launch it from Windows Terminal — that is what the README recommends for the app to display properly.
What inspired tickrs?The author credits ytop, a terminal system monitor by cjbassi, as the inspiration for the project.
Can I pass options on the command line?Yes — tickrs has CLI usage, so you can launch it with command-line options in addition to its config file.
What are similar projects?yfinance, TradingView-API, ta-lib-python, spotify-tui, edit, Crucix, anti-gambling-trader-tw, StockSharp
Which topics is it in?stocks, market-data, stock-market, trading, finance, app, tui, real-time, monitoring, command-line, rust, free
Creator
tarkah
Size
2.7 MB
Stars
1.7K
Updated
CommitMay 19Releasev0.15.0Dec 15
Age
6y
Commits · 90 Days