cointop/README.md

cointop

Coin tracking for hackers

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.

Features

• Quick sort shortcuts
• Vim style keys
• Pagination
• 7 day Charts
• Color coded

Future releases

• Advanced search
• "Favorites" list
• Currency conversion (i.e. Euro, Yen)
• Markets/Exchanges
• CryptoCompare API
• Custom shortcuts

Install

Make sure to have go (1.9+) installed, then do:

go get -u github.com/miguelmota/cointop

Updating

To update make sure to use the -u flag.

go get -u github.com/miguelmota/cointop

Usage

$ cointop

Shortcuts

List of default shortcuts:

Key	Action
↑	Move up
↓	Move down
→	Go to next page
←	Go to previous page
Page Up	Jump page up
Page Down	Jump page down
Home	Go to first line of page
End	Go to last line of page
Enter	Visit highlighted coin on CoinMarketCap
Esc	Alias to quit
Space	Alias to enter key
Ctrl+c	Alias to quit
Ctrl+d	Jump page down (vim style)
Ctrl+n	Go to next page (vim style)
Ctrl+p	Go to previous page (vim style)
Ctrl+r	Force refresh
Ctrl+u	Jump page up (vim style)
Alt+↑	Sort current column in ascending order
Alt+↓	Sort current column in descending order
Alt+←	Sort column to the left
Alt+→	Sort column to the right
F1	Show help
0	Go to first page (vim style)
1	Sort table by [1] hour change
2	Sort table by [2]4 hour change
7	Sort table by [7] day change
a	Sort table by [a]vailable supply
c	Toggle [c]hart for highlighted coin
g	Go to first line of page (vim style)
G	Go to last line of page (vim style)
h	Go to previous page (vim style)
H	Go to top of table window (vim style)
j	Move down (vim style)
k	Move up (vim style)
l	Go to next page (vim style)
L	Go to last line of visible table window (vim style)
m	Sort table by [m]arket cap
M	Go to middle of visible table window (vim style)
n	Sort table by [n]ame
p	Sort table by [p]rice
r	Sort table by [r]ank
s	Sort table by [s]ymbol
t	Sort table by [t]otal supply
u	Sort table by last [u]pdated
v	Sort table by 24 hour [v]olume
q	[q]uit
$	Go to last page (vim style)
?	Show help

FAQ

• Q: Where is the data from?

  • A: The data is from Coin Market Cap.

• Q: What coins does this support?

  • A: This supports any coin listed on Coin Market Cap.

• 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.

    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

License

Released under the MIT license.