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
Что это такое?tickrs показывает в терминале котировки акций в реальном времени; написан на Rust, данные берутся с Yahoo! Finance.
Это сайт, десктопное приложение или оно запускается в терминале?Оно полностью работает в терминале как TUI-приложение (с текстовым интерфейсом) и построено на библиотеке tui-rs для Rust.
Нужны ли аккаунт или API-ключ, чтобы получать данные по акциям?Никакой дополнительной настройки: котировки берутся напрямую с Yahoo! Finance, а в README не упоминаются ни аккаунт, ни API-ключ, ни другие требования.
А на Windows он работает так же?Да, но запускайте его из Windows Terminal — именно это README рекомендует, чтобы приложение отображалось корректно.
Что вдохновило автора на создание tickrs?Автор называет источником вдохновения проекта ytop — монитор системных ресурсов для терминала от cjbassi.
Можно ли передавать параметры в командной строке?Да — у tickrs есть CLI-usage, так что запустить его можно с опциями командной строки, помимо файла конфигурации.
What are similar projects?CNEquity, TradingView-API, yfinance, ta-lib-python, Crucix, spotify-tui, edit, anti-gambling-trader-tw
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