Skip to content

Latest commit

 

History

History
131 lines (91 loc) · 4.79 KB

README.md

File metadata and controls

131 lines (91 loc) · 4.79 KB


logo


cointop

Coin tracking for hackers

License Build Status Go Report Card GoDoc Mentioned in Awesome Terminals PRs Welcome

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 and shortcut keys are inspired by vim.

cointop screenshot

Demo

This connects to an instance of Cointop using SSH:

ssh cointop.sh

In action

screencast

Table of Contents

Documentation has been moved to docs.cointop.sh

Getting Started

Follow these steps to set up and run the project locally.

Prerequisites

Installation

  1. Clone the repository

    git clone https://github.com/spxzzo/cointop.git
    cd cointop
  2. Install dependencies

go mod tidy
  1. Run the project
go run main.go

Features

  • Shortcut keys: Vim-inspired shortcut keys, custom key bindings configuration
  • Colorschemes: Custom colorscheme configuration, 256-color and 24-bit support
  • Favorites: Save and view favorite coins
  • Portfolio: Portfolio tracking of holdings, view profit & loss
  • Charts: Charts for coin price history and global market graphs
  • Search: Fuzzy searching for finding coins
  • Conversion: Currency conversion
  • Price Alerts: Price alerts with desktop notifications
  • Multiple APIs: Supports multiple coin data APIs; CoinGecko and CoinMarketCap
  • Mouse: Mouse support
  • Offline: Offline cache
  • Fast: Fast sort shortcuts, pagination, chart date range change, auto-refresh
  • Lightweight: It's very lightweight; can be left running indefinitely

Contributing

See docs.cointop.sh/contributing

Many thanks to Simon Roberts, Alexis Hildebrandt, and all the contributors that made cointop better.

Social

Mentioned in

Cointop has been mentioned in:

Tip Jar

BTC Tip Jar 3KdMW53vUMLPEC33xhHAUx4EFtvmXQF8Kf

ETH Tip Jar 0xC014b8F6F43f467922E93De62C9216F0538E0F8f

Thank you for tips! 🙏

License

Released under the Apache 2.0 license.

© Miguel Mota