Skip to content

Latest commit

 

History

History
142 lines (90 loc) · 3.13 KB

README.md

File metadata and controls

142 lines (90 loc) · 3.13 KB
Raw

mento-cli

CLI for interacting with the Mento protocol

oclif Version Downloads/week

📋 Table of Contents

  1. 🔨 Getting Started

  2. 🚀 Usage

  3. ✨ Misc commands

  4. ©️ License

🔨 Getting Started

To get started working on this, you will need to have the following on your machine :

PNPM

Typescript

Then, run the following commands to build and use the cli locally:

# Install dependencies
pnpm install

# Build the project
pnpm run build

# Run CLI locally
pnpm run dev

🚀 Usage

An NPM package for the CLI does not yet exist, at this time the easiest way to get started is to create a global alias:

# Ensure the app is built
pnpm run build

# At the project root run this command to crete a global CLI alias
pnpm link --global

# Now you can run anywhere using
mento

✨ Commands

mento pools list

List all pools with their basic information

USAGE
  $ mento pools list [-p]

FLAGS
  -p, --pretty  Format output in a table and which includes token addresses.

EXAMPLES
  List all pools.

    $ mento pools list

  List all pools in an ugly tabe. Only looks pretty with a full screen terminal.

    $ mento pools list -p

mento pools info POOLID

Get information about a specific pool

USAGE
  $ mento pools info POOLID

ARGUMENTS
  POOLID  ID of pool to be retrieved

EXAMPLES
  Get information for the cUSD/CELO pool on mainnet.

    $ mento pools info 0x3135b662c38265d0655177091f1b647b4fef511103d06c016efdf18b46930d2c

mento config COMMAND

Get/set the configuration options for the CLI

USAGE
  $ mento config COMMAND

COMMANDS
  config get  Get configuration options for the CLI
  config set  Set configuration options for the CLI

EXAMPLES

  Get the configurable options
    $ mento config get

  Set a configurable options
    $ mento config set FLAG

mento config set FLAG

Set the value for the configuration option with the given flag

USAGE
  $ mento config set -r <value>

FLAGS
  -r, --rpcUrl=<value>  (required) Specify the RPC URL to use

EXAMPLES

  Set the rpc url to use for the cli.
    $ mento config get set -r https://alfajores-forno.celo-testnet.org

©️ License

This project is licensed under the MIT License.

If you want to contribute to this project, please read the contribution guide