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 是一个在终端里实时显示股票行情的工具,用 Rust 编写,行情数据来自 Yahoo! Finance。
这是网站、桌面应用,还是在我的终端里运行?它完全在终端里运行,是一个 TUI(文本用户界面)应用,基于 Rust 的 tui-rs 库构建。
获取股票数据需要注册账号或 API 密钥吗?不需要任何额外配置:行情数据直接来自 Yahoo! Finance,README 里也没有提到需要账号、API 密钥或其他前提条件。
在 Windows 上运行效果一样吗?可以运行,但要从 Windows Terminal 启动——README 建议这样启动,应用才能正常显示。
tickrs 的灵感来自什么?作者表示,这个项目的灵感来自 cjbassi 开发的终端系统监视器 ytop。
我可以在命令行里传参数吗?可以——tickrs 支持命令行用法,除了配置文件之外,你还可以通过命令行选项来启动它。
Creator
tarkah
Size
2.7 MB
Stars
1.7K
Age
6y
Commits · 90 Days