mirror of https://github.com/miguelmota/cointop
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
136 lines
4.0 KiB
Markdown
136 lines
4.0 KiB
Markdown
# cointop
|
|
|
|
> Coin tracking for hackers
|
|
|
|
[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/miguelmota/cointop/master/LICENSE.md) [![Build Status](https://travis-ci.org/miguelmota/cointop.svg?branch=master)](https://travis-ci.org/miguelmota/cointop) [![Go Report Card](https://goreportcard.com/badge/github.com/miguelmota/cointop?)](https://goreportcard.com/report/github.com/miguelmota/cointop) [![GoDoc](https://godoc.org/github.com/miguelmota/cointop?status.svg)](https://godoc.org/github.com/miguelmota/cointop)
|
|
|
|
<img src="./assets/screenshot-001.gif" width="880" />
|
|
|
|
[`cointop`](https://github.com/miguelmota/cointop) is a fast and lightweight interactive terminal based UI application for tracking and monitoring cryptocurrency coin stats in real-time. The interface is inspired by [`htop`](https://en.wikipedia.org/wiki/Htop).
|
|
|
|
## Features
|
|
|
|
- Quick sort shortcuts
|
|
- Vim style keys
|
|
- Pagination
|
|
- Color coded
|
|
|
|
#### Future releases
|
|
|
|
- Advanced search
|
|
- "Favorites" list
|
|
- Coin charts
|
|
- Currency conversion (i.e. Euro, Yen)
|
|
- Markets/Exchanges
|
|
- CryptoCompare API
|
|
- Custom shortcuts
|
|
|
|
## Install
|
|
|
|
Make sure to have [go](https://golang.org/) (1.9+) installed, then do:
|
|
|
|
```bash
|
|
go get -u github.com/miguelmota/cointop
|
|
```
|
|
|
|
<!--
|
|
#### Alternatively (without go)
|
|
|
|
```
|
|
sudo curl -s "https://raw.githubusercontent.com/miguelmota/cointop/master/install.sh?$(date +%s)" | bash
|
|
```
|
|
-->
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
$ cointop
|
|
```
|
|
|
|
### Cointop commands
|
|
|
|
List of default shortcuts:
|
|
|
|
Key|Action
|
|
----|------|
|
|
<kbd>↑</kbd>|Move up
|
|
<kbd>↓</kbd>|Move down
|
|
<kbd>→</kbd>|Go to next page
|
|
<kbd>←</kbd>|Go to previous page
|
|
<kbd>Page Up</kbd>|Jump page up
|
|
<kbd>Page Down</kbd>|Jump page down
|
|
<kbd>Home</kbd>|Go to first line of page
|
|
<kbd>End</kbd>|Go to last line of page
|
|
<kbd>Enter</kbd>|Visit highlighted coin on [CoinMarketCap](https://coinmarketcap.com/)
|
|
<kbd>Esc</kbd>|Alias to quit
|
|
<kbd>Space</kbd>|Alias to enter key
|
|
<kbd>Ctrl</kbd>+<kbd>c</kbd>|Alias to quit
|
|
<kbd>Ctrl</kbd>+<kbd>d</kbd>|Jump page down (vim style)
|
|
<kbd>Ctrl</kbd>+<kbd>n</kbd>|Go to next page (vim style)
|
|
<kbd>Ctrl</kbd>+<kbd>p</kbd>|Go to previous page (vim style)
|
|
<kbd>Ctrl</kbd>+<kbd>r</kbd>|Force refresh
|
|
<kbd>Ctrl</kbd>+<kbd>u</kbd>|Jump page up (vim style)
|
|
<kbd>0</kbd>|Go to first page (vim style)
|
|
<kbd>1</kbd>|Sort table by *[1] hour change*
|
|
<kbd>2</kbd>|Sort table by *[2]4 hour change*
|
|
<kbd>7</kbd>|Sort table by *[7] day change*
|
|
<kbd>a</kbd>|Sort table by *[a]vailable supply*
|
|
<kbd>g</kbd>|Go to first line of page (vim style)
|
|
<kbd>G</kbd>|Go to last line of page (vim style)
|
|
<kbd>h</kbd>|Go to previous page (vim style)
|
|
<kbd>H</kbd>|Go to top of table window (vim style)
|
|
<kbd>j</kbd>|Move down (vim style)
|
|
<kbd>k</kbd>|Move up (vim style)
|
|
<kbd>l</kbd>|Go to next page (vim style)
|
|
<kbd>L</kbd>|Go to last line of visible table window (vim style)
|
|
<kbd>m</kbd>|Sort table by *[m]arket cap*
|
|
<kbd>M</kbd>|Go to middle of visible table window (vim style)
|
|
<kbd>n</kbd>|Sort table by *[n]ame*
|
|
<kbd>p</kbd>|Sort table by *[p]rice*
|
|
<kbd>r</kbd>|Sort table by *[r]ank*
|
|
<kbd>s</kbd>|Sort table by *[s]ymbol*
|
|
<kbd>t</kbd>|Sort table by *[t]otal supply*
|
|
<kbd>u</kbd>|Sort table by *last [u]pdated*
|
|
<kbd>v</kbd>|Sort table by *24 hour [v]olume*
|
|
<kbd>q</kbd>|[q]uit
|
|
<kbd>$</kbd>|Go to last page (vim style)
|
|
|
|
<!--
|
|
|`h`|toggle [h]elp|
|
|
|`?`|alias to help|
|
|
-->
|
|
|
|
## FAQ
|
|
|
|
- Q: Where is the data from?
|
|
|
|
- A: The data is from [Coin Market Cap](https://coinmarketcap.com/).
|
|
|
|
- Q: What coins does this support?
|
|
|
|
- A: This supports any coin listed on [Coin Market Cap](https://coinmarketcap.com/).
|
|
|
|
- Q: How often is the data polled?
|
|
|
|
- A: Data gets polled once every minute by default.
|
|
|
|
- Q: I installed cointop without errors but the command is not found.
|
|
|
|
- A: Make sure your `GOPATH` and `PATH` is set correctly.
|
|
```bash
|
|
export GOPATH=$HOME/go
|
|
export PATH=$PATH:$GOPATH/bin
|
|
```
|
|
|
|
- Q: What is the size of the binary?
|
|
|
|
- A: The executable is only ~1.9MB in size.
|
|
|
|
## Authors
|
|
|
|
- [Miguel Mota](https://github.com/miguelmota)
|
|
|
|
## License
|
|
|
|
Released under the MIT license.
|