Greenfield CMD TypeScript

Greenfield CMD TypeScript is a powerful command-line tool developed in TypeScript for carrying out a variety of tasks. The tool provides a versatile set of commands, enabling you to perform a range of operations.

Primary repository

The primary repository for this project is hosted on GitHub. You can access it via the following URL:

Greenfield CMD TypeScript Repository

Libraries Used

This project is primarily built with TypeScript, Node.js, and npm. It also makes extensive use of the Greenfield JS SDK, a library developed by BnB-Chain.

Installation

To run this project, you need to have Git and Node.js installed on your machine.

Clone the repository by running the following command in your terminal:

git clone https://github.com/Abyl10/greenfield-cmd-typescript.git

Navigate into the project directory:

cd greenfield-cmd-typescript

Install the project dependencies:

npm install

Build

After the installation process is complete, you need to build the project before running any commands. To build the project, run the following command:

npm run build

You may see this errors after building:

Found 10748 errors in 24 files.

Errors  Files
     1  node_modules/.pnpm/@bnb-chain+greenfield-chain-sdk@0.2.0/node_modules/@bnb-chain/greenfield-chain-sdk/dist/esm/types/common.d.ts:2
  1062  node_modules/.pnpm/@bnb-chain+greenfield-cosmos-types@0.4.0-alpha.9/node_modules/@bnb-chain/greenfield-cosmos-types/cosmos/bank/v1beta1/query.d.ts:421

but this is a typescript error from @bnb-chain+greenfield-chain-sdk library. These errors will not affect to our cli commands.

Go to .env file and write your metamask address and primary key:

ADDRESS="0x..."
PRIVATE_KEY=""

Usage

Once the project has been successfully built, you can run the command gnfd-cmd to see the list of available commands. Execute the following command in your terminal:

gnfd-cmd

if it is not working, you can try:

npm i -g 

gnfd-cmd

This will display a list of available commands that you can use:

Usage: gnfd-cmd [options] [command]

A CLI tool for Greenfield

Options:
  -V, --version                          output the version number
  -h, --help                             display help for command

Commands:
  bucket                                 Support the bucket operation functions, including create/update/delete/head/list
  object                                 Support the object operation functions, including put/get/update/delete/head/list and so on
  group                                  (not implemented) Support the group operation functions, including create/update/delete/head/head-member
  crosschain                             Support the cross-chain functions, including transfer and mirror
  bank                                   Bank operations
  policy                                 (not implemented) Support object policy and bucket policy operation functions
  payment                                (not implemented) Support the payment operation functions
  sp                                     Support the storage provider operation functions
  (not <implemented)> <create-keystore>  Create a new keystore file
  help [command]                         display help for command

Contributing

Contributions to this project are welcome. Feel free to open issues or submit pull requests for any improvements or bug fixes.

License

This project is licensed under the MIT License. Feel free to use and modify it according to your needs.

Abyl10 / greenfield-cmd-typescript