/tmux-crypto

A Tmux plugin to monitor crypto currency prices.

Primary LanguageShellMIT LicenseMIT

Tmux Plugin to Monitor Crytocurrency Prices

Status License

Status

Index

Getting Started

Keep a tarck of crypto currencies right from tmux. You can choose between the following fiat currencies:

  • AUD → A$
  • CAD → C$
  • CHF → Fr
  • DKK → kr
  • EUR → €
  • GBP → £
  • NOK → kr
  • SEK → kr
  • USD → $

Current supported crypto currencies are:

  • Cardano → ADA
  • Bitcoin → BTC
  • Polkadot → DOT
  • Kusama → KSM
  • Ethereum → ETH
  • Chainlink → LINK
  • Litecoin → LTC
  • Nano → NANO

The data is fetched from Kraken's API. For some fiat currencies the data is fetched from Exchange Rates API. For more crypto currency requests, drop it here

Screenshots

Terminal and Tmux theme shown here is Lighthaus

Tmux Lighthaus theme coming soon

Requirements

  • TPM is the recommended method of installing this plugin
  • curl
  • jq

Installation

Recommended method:

  • Add plugin to your TPM plugins in your .tmux.conf
    •   set -g @plugin 'Brutuski/tmux-crypto'
  • While inside a tmux session press prefix + I to reload and install the plugin.
  • Add the desired format strings to your status as such
    •   #{eth_eur}
  • Reload the tmux config and the changes should take effect.

Manual Installation:

  • Clone this repo
    •   git clone https://github.com/Brutuski/tmux-crypto.git ~/.tmux/tmux-crypto
  • Add the following line to the bottom of your tmux config
    •   run-shell ~/.tmux/tmux-crypto/crypto.tmux
  • Save the file and reload your tmux session.

Usage

  • Add the desired format strings to your status as such. All supported format strings listed below in options
    •   #{eth_usd} #{btc_usd}
  • Reload the tmux config and the changes should take effect.

Options

All available format strings and options can be found in OPTIONS.

Example

Format strings can be edited to what the user needs. fg and bg colors can be defined by the user as well.

set -g status-left "......#[fg=#21252D,bg=#5AD1AA] #{eth_eur} | #{ada_eur} "

Changelog

v 1.2.2

Changes can be tracked in the CHANGELOG

Issues

Please report any bugs or issues here.

License

MIT

Copyright (c) 2021 Adhiraj Sirohi

Logo Credit

Logo was made by Vasundhara Sharma https://www.behance.net/vasundhsharma https://keybase.io/vas_sharma