wenmoon

Crates.iowenmoon
lib.rswenmoon
version0.3.0
sourcesrc
created_at2024-02-27 12:37:13.935227
updated_at2024-04-01 08:43:54.680371
descriptionYour crypto portfolio and terminal together at last
homepagehttps://github.com/shapeshed/wenmoon
repositoryhttps://github.com/shapeshed/wenmoon
max_upload_size
id1155058
size123,671
(shapeshed)

documentation

README

Wen moon?

GitHub Actions CI Workflow Status GitHub Actions Release Workflow Status Crates.io Version

Your crypto portfolio and terminal together at last :handshake:

wen moon?

Installation

From cargo

cargo install wenmoon --locked

Build from source

git clone https://github.com/shapeshed/wenmoon
cd wenmoon
cargo install --path .

Configuration

The following are supported as data providers

CoinMarketCap

Obtain a CoinMarketCap API key. Create a file at ~/.config/wenmoon/config.yml. Ticker values can be found by searching on CoinMarketCap.

amount and entry_price are optional fields if you want to compute the value and P&L of your position.

coinmarketcap:
  api_key: [YOUR_API_KEY_HERE]
portfolio:
  - ticker: AAVE
    amount: 100.02
    entry_price: 100.02
  - ticker: MATIC
    amount: 0.643
    entry_price: 1.22
  - ticker: SOL
    amount: 98.45
    entry_price: 150
  - ticker: OSMO
    amount: 265.84
    entry_price: 1.45
  - ticker: KUJI
    amount: 1053.34
    entry_price: 3.95

CoinGecko

Obtain a CoinGecko API key. Create a file at ~/.config/wenmoon/config.yml. Ticker values can be found by searching for the coin on CoinGecko and finding the API ID field under Info.

amount and entry_price are optional fields if you want to compute the value and P&L of your position.

coingecko:
  api_key: [YOUR_API_KEY_HERE]
portfolio:
  - ticker: aave
    amount: 100.02
    entry_price: 100.02
  - ticker: matic-network
    amount: 0.643
    entry_price: 1.22
  - ticker: solana
    amount: 98.45
    entry_price: 150
  - ticker: osmosis
    amount: 265.84
    entry_price: 1.45
  - ticker: kujira
    amount: 1053.34
    entry_price: 3.95

Usage

Vanilla usage. Will read file from ~/.config/wenmoon/config.yml

wenmoon

Custom config file. Pass the -c flag followed by the path to the file

wenmoon -c ./path/to/custom/config.yml

Multiple portfolios and watchlists using different files

wenmoon -c ~/.config/wenmoon/watchlist.yml
wenmoon -c ~/.config/wenmoon/shitcoins.yml
wenmoon -c ~/.config/wenmoon/vegas_fund.yml

Sorting the list on hourly, daily, weekly and monthly change

wenmoon -s h
wenmoon -s d
wenmoon -s w
wenmoon -s m

If your list is long and you just want to see a single price wenmoon plays nice with UNIX tools such as grep or ripgrep.

wenmoon | grep BTC
wenmoon | rg BTC
Commit count: 34

cargo fmt