Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Brutuski/tmux-ticker
A Tmux plugin to monitor various indexes and stock prices.
https://github.com/Brutuski/tmux-ticker
market stock stock-data stock-market stocks tmux tmux-conf tmux-configs tmux-plugin tmux-plugins
Last synced: 3 months ago
JSON representation
A Tmux plugin to monitor various indexes and stock prices.
- Host: GitHub
- URL: https://github.com/Brutuski/tmux-ticker
- Owner: Brutuski
- License: mit
- Created: 2021-02-05T13:17:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-26T06:50:01.000Z (8 months ago)
- Last Synced: 2024-06-18T07:32:59.148Z (5 months ago)
- Topics: market, stock, stock-data, stock-market, stocks, tmux, tmux-conf, tmux-configs, tmux-plugin, tmux-plugins
- Language: Shell
- Homepage:
- Size: 119 KB
- Stars: 34
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Tmux-Ticker
### Index
- [Getting Started](#getting-started)
- [Screenshots & Demo](#screenshots)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Options](#options)
- [Example](#example)
- [Changelog](#changelog)
- [Issues](#issues)
- [License](#license)
- [Logo Credit](#logo-credit)
#### Getting Started
Ticker helps you keep track of various _market indexes_ or a _stock_ you would like to keep an eye out on.
Their percentage changes can be tracked as well.
This plugin also supports some of the _top crypto currencies_ as well.
If you would like to track more cyrpto currencies with various different fiat currency support, use [tux-crypto](https://github.com/Brutuski/tmux-crypto) instead.
The data is fetched from [Marketwatch](https://www.marketwatch.com/).
_Currently only US Markets are supported._
Crypto Data is fetched from [Cryptonator](https://www.cryptonator.com/).
Supported Indexes:
- Dow Jones Industrial Average -> DJI
- #{ticker_dji}
- #{ticker_dji_change}
- NASDAQ Composite Index -> COMP
- #{ticker_nasdaq}
- #{ticker_nasdaq_change}
- S&P 500 Index -> SPX
- #{ticker_sp100}
- #{ticker_sp100_change}
- S&P 100 Index -> OEX
- #{ticker_sp500}
- #{ticker_sp500_change}
- Any stock ticker can also be added.
- #{ticker_stock}
- Cryptocurrency ticker can also be added.
- #{ticker_crypto}
#### Screenshots
Terminal and Tmux theme shown here is [Lighthaus](https://github.com/lighthaus-theme)
_Tmux Lighthaus theme coming soon_
#### Requirements
- [TPM](https://github.com/tmux-plugins/tpm) is the recommended method of installing this plugin
- [curl](https://github.com/curl/curl)
#### Installation
**Recommended method:**
- Add plugin to your [TPM](https://github.com/tmux-plugins/tpm) plugins in your `.tmux.conf`
- ```vim
set -g @plugin 'Brutuski/tmux-ticker'
```
- While inside a tmux session press `prefix + I` to reload and install the plugin.
- Add the desired _format strings_ to your status as such
- ```vim
#{ticker_dji} #{ticker_stock}
```
- Reload the tmux config and the changes should take effect.
**Manual Installation:**
- Clone this repo
- ```sh
git clone https://github.com/Brutuski/tmux-ticker.git ~/.tmux/tmux-ticker
```
- Add the following line to the bottom of your tmux config
- ```vim
run-shell ~/.tmux/tmux-ticker/ticker.tmux
```
- Save the file and reload your tmux session.
#### Usage
- Change the following format string with the stock ticker
- ```vim
set -g @ticker_stock "AAPL"
#{ticker_stock}
```
- Change the following format string with the crypto ticker
- ```vim
set -g @ticker_crypto "BTC-USD"
#{ticker_crypto}
```
- Reload the tmux config and the changes should take effect.
#### Options
All available format strings
```vim
# Replace the name with the stock you would like to track.
set -g @ticker_stock "AAPL"
# You can also set styles for the ticker_stock based on stock movement direction
set -g @ticker_positive_style "#[fg=#A7C080, bg=#414550]"
set -g @ticker_negative_style "#[fg=#FF4858, bg=#414550]"
# Then use it in your status line
set -g status-left "......#[fg=#21252D,bg=#5AD1AA] #{ticker_nasdaq} ~ #{ticker_stock} ~ #{ticker_stock_change} "
```
#### Example
Format strings can be edited to what the user needs.
_fg_ and _bg_ colors can be defined by the user.
```vim
set -g @ticker_stock "AAPL"
set -g status-left "......#[fg=#21252D,bg=#5AD1AA] #{ticker_nasdaq} ~ #{ticker_nasdaq_change} #{ticker_stock} "
```
#### Changelog
```vim
v 1.1.2
```
Changes can be tracked in the [CHANGELOG](https://github.com/Brutuski/tmux-ticker/blob/main/CHANGELOG.md)
#### Issues
Please report any bugs or issues [here](https://github.com/Brutuski/tmux-ticker/issues).
#### License
[MIT](https://github.com/Brutuski/tmux-ticker/blob/main/LICENSE)
_Copyright (c) 2021 Adhiraj Sirohi_
#### Logo Credit
Logo was made by [Vasundhara Sharma](https://vasdesigns.de/)
