Thanks to visit codestin.com
Credit goes to github.com

Skip to content

juanpalopez/coingecko-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CoinGecko CLI

In this project, we will be implementing a CLI that maps to CoinGecko API https://www.coingecko.com/en/api/documentation#

Command Status
ping Done
simple Done
coins
contract
asset_platforms In progress
categories
exchanges
indexes
derivatives
nfts
exchange_rates
search
trending
global
companies

Each of them will have one or more subcommands, you may find more details in the API documentation. Initially, we will be supporting the Free API which currently supports 10-30 calls/minute and doesn't require an API key.

The project will be implemented using Rust.

How to install the project

To install the project, please follow these steps:

  1. Clone the repository:

    git clone https://github.com/juanpalopez/coingecko-cli.git
  2. Change to the project directory:

    cd coingecko-cli
  3. Build the project using Cargo:

    # build debug mode
    cargo build
    # or
    # build release mode
    cargo build --release

Congratulations! The project is now installed and ready to use.

How to Run the CLI

After installing the project, you can run the CLI with the following steps:

  1. If you're not already in the project directory, navigate to it:

    cd coingecko-cli
  2. To run the CLI in debug mode, use:

    cargo run
  3. To run the CLI with arguments, append them after -- in the command line:

    cargo run -- [arguments]

    For example, to run a command ping, you would use:

    cargo run -- ping
  4. If you built the project in release mode and want to run the release version, navigate to the target/release directory and run the executable directly:

    cd target/release
    ./coingecko-cli [arguments]

    Replace [arguments] with any specific commands or options your CLI supports.

  5. To view all available commands and their descriptions, you can use the help command:

    cargo run -- --help

    Or, if running a built-release version:

    ./coingecko-cli --help
    

Congratulations! You are now running the CLI.

About

This is CLI for CoinGecko API build in rust

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages