nostalcade/satori-cli

Crypto Market directly from the command-line and through an interactive interface. Powered by CoinGecko API

---

Satori allows you to obtain information in order to understand the present crypto market directly from the command-line and through an interactive interface, all information is obtained through the CoinGecko API.

Features

• Top Coins

  • 10, 50 & 100

• Search coin data

  • Bitcoin, Monero, etc.

• Obtain coin price

  • USD, JPY, BTC, etc.

• Check API Status

Tech Stack

• Runtime Environment

  • Node.js

• CLI

  • Commander.js

• Interactive CLI

  • Inquirer.js

• Text Table

  • Table

• Format Crypto & Fiat

  • Cryptoformat

• Colors & Styles

  • Colors.js

• ASCII Art

  • FIGlet

• HTTP Client

  • Axios

• Automatic Restart

  • nodemon

• API

  • CoinGecko API

Run

Install required

• Node.js/npm/npx

npx

Start Interactive CLI

npx satori-cli

npm

Install package globally

npm i -g satori-cli

Start Interactive CLI

satori-cli

Locally

Clone the repository

• HTTPS

  git clone https://github.com/nostalcade/satori-cli.git

• SSH

  git clone [email protected]:nostalcade/satori-cli.git

Go to the repository directory

cd satori-cli/

Install dev/Dependencies

npm i

Create global symlink

npm link

Start Interactive CLI

satori-cli

All-In-One

• HTTPS

  git clone https://github.com/nostalcade/satori-cli.git; cd satori-cli/; npm i; npm link; satori-cli;

• SSH

  git clone [email protected]:nostalcade/satori-cli.git; cd satori-cli/; npm i; npm link; satori-cli;

CLI Reference

Index

1. Usage

2. Global Options

   2.1. version

   2.2. help

3. Commands

   3.1. interactive

   3.2. top

   3.3. search

   3.4. price

   3.5. status

   3.5. help

1. Usage

• Synopsis

  satori-cli [options] [command]

2. Global Options

2.1. version

• Synopsis

  satori-cli [options]

• Options

  • -V, --version

    • Output the version number

2.2. help

• Synopsis

  satori-cli [options]

• Options

  • -h, --help

    • Display help for command

3. Commands

3.1. interactive

• Description

  • Start Interactive CLI (Default Command)

• Synopsis

  satori-cli [options]

  satori-cli interactive [options]

• Options

  • help

3.2. top

• Description

  • Top Coins: 10, 50 & 100

• Synopsis

  satori-cli top [options]

• Options

  • -10

    • Top 10 Coins

  • -50

    • Top 50 Coins

  • -100

    • Top 100 Coins

  • help

3.3. search

• Description

  • Search coin data

• Synopsis

  satori-cli search [options] <coinId>

• Arguments

  • coinId

    • Bitcoin, Monero, etc.

• Options

  • help

3.4. price

• Description

  • Obtain coin price

• Synopsis

  satori-cli price [options] <coinId> <currency>

• Arguments

  • coinId

    • Bitcoin, Monero, etc.

  • currency

    • USD, JPY, BTC, etc.

• Options

  • help

3.5. status

• Description

  • Check API Status

• Synopsis

  satori-cli status [options]

• Options

  • help

3.6. help

• Description

  • Display help for command

• Synopsis

  satori-cli help [command]

• Commands

  • Commands

Screenshots

Interactive CLI

License

• MIT