1.0.2 • Published 5 months ago

@hirano-vm4/mycrypto v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

mycrypto

日本語の README は README(JP).md を確認してください

mycrypto is a command-line tool that allows you to easily access detailed trading data and market transaction information of the entire cryptocurrency market right from your terminal. It enables access to a wide range of data, including real-time price fluctuations, market trends, and vital statistical information for each cryptocurrency.

This tool facilitates quick and efficient information gathering. It supports approximately 2400 different cryptocurrency assets, and you can search for any asset not displayed at the top by using the Ticker search.

Features

  • Access to comprehensive market trading information for the entire cryptocurrency market
  • Supports approximately 2,400 cryptocurrency assets (using the Coinlore API)
  • Ticker search functionality

How to Use

Use npx to run mycrypto:

npx @hirano-vm4/mycrypto

Prerequisites

Before installing mycrypto, ensure that your system meets the following prerequisites:

  • Node.js: You need to have Node.js installed on your system. The version required for mycrypto is version 10.0.0 or higher. You can download and install Node.js from Node.js official website. Additionally, mycrypto relies on the following Node.js packages, which will be installed automatically when you install the tool:

  • axios (v1.6.2 or higher): Used for making HTTP requests to fetch cryptocurrency data.

  • cli-table2 (v0.2.0 or higher): Utilized for rendering tables in the terminal.
  • enquirer (v2.4.1 or higher): Employed for interactive command-line interfaces. No other specific software or libraries are required to run mycrypto beyond what is listed here. Ensure that your Node.js environment is set up correctly to proceed with the installation.

Table Overview

The mycrypto application provides a detailed table view of cryptocurrency data. Below is an overview of the information provided in each table row:

Market Overview Table

TitleDescription
Price Checked AtThe time when the information was fetched. Format: YYYY/MM/DD HH:MM:SS
Total Market CapTotal market capitalization of all cryptocurrencies
Market Cap Change (24h)Market cap change rate of the entire market over the past 24 hours
Total VolumeTotal trading volume of all cryptocurrencies in the market
Volume Change (24h)Trading volume change rate of the market over the past 24 hours
Bitcoin Market DominanceThe percentage of the total market cap represented by Bitcoin
Ethereum Market DominanceThe percentage of the total market cap represented by Ethereum
All-Time High VolumeThe highest recorded trading volume in the entire crypto market
All-Time High Market CapThe highest recorded market capitalization in the crypto market

Individual Cryptocurrency Table

TitleDescription
Price Checked AtThe time when the information was fetched. Format: YYYY/MM/DD HH:MM:SS
Currency NameName of the cryptocurrency, e.g., Bitcoin
Ticker SymbolMarket symbol of the cryptocurrency, e.g., BTC
Market Cap RankRank of the cryptocurrency based on market capitalization
PriceCurrent price of the cryptocurrency, displayed as $43,376.11/BTC
Price Change (1h)Price change rate over the past 1 hour
Price Change (24h)Price change rate over the past 24 hours
Price Change (7d)Price change rate over the past 7 days
Market CapTotal market capitalization of the cryptocurrency
Volume (24h)Total trading volume of the cryptocurrency over the past 24 hours
Circulating SupplyTotal amount of the cryptocurrency currently in circulation
Total SupplyTotal amount of the cryptocurrency available

Usage Examples

Getting an Overview of the Entire Market

Select Cryptocurrency Market Overview Market Overview

Getting Information on Individual Cryptocurrencies

Select a ticker displayed at the top Individual Cryptocurrencies

Searching for Information by Ticker

Select Other (Ticker Search) Ticker Search

LICENSE

This software is released under the MIT License, see LICENSE.txt.

1.0.2

5 months ago

1.0.1

5 months ago

1.0.0

5 months ago