cointop

Open TUI

$ cointop

$ cointop clean

$ cointop holdings --human

$ cointop price --coins [coin_name1,coin_name2,...]

$ cointop version

cointop [options]

--api-key
    Specify a CoinMarketCap API key for data fetching.

--api-keys-path
    Path to a file containing API keys for multiple services.

--cache-dir
    Path to the cache directory for storing fetched data.

--colors-config-path
    Path to a custom colors configuration file.

--config
    Path to the main configuration file.

--currency
    Set the default fiat currency (e.g., USD, EUR, BTC) for display.

--debug
    Enable debug mode for verbose output.

--export
    Export current market data to a specified file.

--help
    Display help information and exit.

--log-file
    Path to the log file for recording application events.

--max-table-rows
    Set the maximum number of rows to display in the table view.

--no-color
    Disable color output in the terminal.

--open-link-strategy
    Strategy for opening external links (e.g., 'xdg-open', 'open', 'none').

--portfolio
    Start the application directly in the portfolio view.

--refresh-rate
    Set the data refresh rate in seconds.

--reset-config
    Reset the application configuration to its default settings.

--reset-data
    Clear all cached market data.

--secrets-path
    Path to a file containing sensitive information like API keys.

--shortcut
    Define a custom keybinding for an application action.

--skip-checks
    Skip checks for new version updates and configuration changes.

--time-format
    Set the time display format (e.g., '12h', '24h').

--token
    Specify a CoinGecko API token.

--top
    Display only the top N cryptocurrencies by market capitalization.

--version
    Display the application version and exit.

--view-type
    Set the initial view type (e.g., 'table', 'portfolio').

cointop is a fast and lightweight terminal user interface (TUI) application designed for tracking cryptocurrency market data in real-time. Written in Go, it provides an interactive and customizable dashboard displaying live prices, market capitalization, 24-hour volume, supply, and price change percentages for thousands of cryptocurrencies.

Users can easily search, sort, and filter coins, switch between different fiat currencies, and customize the display columns. It leverages various cryptocurrency APIs to fetch up-to-date information, offering a convenient way for enthusiasts and traders to monitor market movements directly from their command line. Its intuitive keybindings and minimalist design make it efficient for quick market overviews.

cointop requires an active internet connection to fetch real-time market data. Users should be aware of potential API rate limits imposed by data providers like CoinMarketCap or CoinGecko, especially without a paid API key. The accuracy of data depends on the reliability of the underlying APIs. It functions purely as a monitoring tool and does not offer any direct trading or investment functionalities.

cointop features a comprehensive set of interactive keybindings for efficient navigation and interaction within the TUI. Common keybindings include q to quit, f to toggle favorite coins, s to search, p to switch to portfolio view, and ? to display a help menu. These shortcuts allow users to quickly perform actions without relying on mouse input, enhancing productivity directly from the terminal.

Users can extensively customize cointop's behavior and appearance through its configuration files, typically located in ~/.cointop/config.yaml. This includes setting the default fiat currency, configuring API keys, adjusting refresh rates, customizing color themes, and even defining personalized keybindings. This level of flexibility enables users to tailor the application precisely to their workflow and aesthetic preferences.

cointop was initially developed by Ben La Monica (miguelmota) and emerged around late 2017 / early 2018, coinciding with a period of significant growth in cryptocurrency interest. Written in Go, its primary goal was to provide a fast, cross-platform, and user-friendly terminal interface for tracking crypto market data. It quickly gained traction within the open-source community, leading to continuous development, feature enhancements, and integrations with multiple data providers, solidifying its position as a popular command-line tool for cryptocurrency monitoring.

curl(1), htop(1), btop(1), ncdu(1), tmux(1), screen(1)