Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ElvenTools/elven-tools-cli

Elven Tools CLI - command line tool for launching NFTs collections on the MultiversX blockchain (Plus other tools).
https://github.com/ElvenTools/elven-tools-cli

blockchain cli elrond javascript multiversx nft nodejs sft

Last synced: 2 months ago
JSON representation

Elven Tools CLI - command line tool for launching NFTs collections on the MultiversX blockchain (Plus other tools).

Awesome Lists containing this project

README 

        
### Elven Tools CLI



- Docs: [www.elven.tools](https://www.elven.tools)

- Elven Tools Twitter: [www.twitter.com/ElvenTools](https://twitter.com/ElvenTools)

- Quick jumpstart: [www.elven.tools/docs/jump-start.html](https://www.elven.tools/docs/jump-start.html)

- Recipes: [www.elven.tools/docs/recipes.html](https://www.elven.tools/docs/recipes.html)

- Intro NFT video: [youtu.be/Jou5jn8PFz8](https://youtu.be/Jou5jn8PFz8)

- Intro SFT video: [youtu.be/rMF3ItijHUA](https://youtu.be/rMF3ItijHUA)



### What is it?



The CLI tool helps to:

- deploy the NFT and SFT minter smart contracts on the MultiversX blockchain

- setup and interact with the NFT and SFT minter smart contracts on the MultiversX blockchain

- provides a couple of helper tools for getting the data from API (NFTs)

  - get collection owners => [docs](https://www.elven.tools/docs/recipes.html#how-to-get-owners-addresses-using-the-collection-ticker)

  - filter and export the data

  - distribute EGLD, ESDT, SFT and Meta ESDT to the NFT owners of a collection => [docs](https://www.elven.tools/docs/recipes.html#how-to-distribute-tokens-to-nft-owners)



For now it is designed to deploy contracts:

- [elven-tools-nft-minter-sc](https://github.com/ElvenTools/elven-nft-minter-sc),

- [elven-tools-sft-minter-sc](https://github.com/ElvenTools/elven-tools-sft-minter-sc)



Be aware that smart contracts doesn't have any audits. They has complete functionality for the first versions, but they still needs some improvements. Test them first on the devnet/testnet.



**You can use [elven-tools-dapp](https://github.com/ElvenTools/elven-tools-dapp) as your frontend dapp for minting process! (NextJS based app with all 4 auth providers included, and React hooks for interaction)** (Learn more about it here: [How to start with the Dapp](https://www.elven.tools/docs/how-to-start-with-the-dapp.html)) For now, by default it supports only NFT smart contract, but it will handle both in the future.



### Tracking the progress



- [Elven Tools CLI kanban](https://github.com/orgs/ElvenTools/projects/3)



### How does it work?



The Elven Tools CLI is a Node.js command line tool. Your machine must have [Node.js](https://nodejs.org/en) installed.



#### General how to:



- `npm install elven-tools -g` - install elven-tools cli tool

- `elven-tools --version` or `elven-tools -v` - check current version

- `elven-tools --help` or `elven-tools -h` - for getting the commands on the root level

- `elven-tools nft-minter --help` or `elven-tools nft-minter -h` - for getting all the commands for the subcommand



**You can also use it with `npx` directly. For example:**

- `npx elven-tools@latest deploy nft-minter`



#### Steps for deploying and interacting with the Smart Contract:



Check out the TL;DR and longer description here: [Jump start](https://www.elven.tools/docs/jump-start.html#tl%3Bdr)



### Check out possible workflows



For NFT: Examples of how you can configure your Smart Contract in a couple of scenarios and how to use the CLI to do this faster and more efficient: [www.elven.tools/docs/elven-tools-workflows.html](https://www.elven.tools/docs/elven-tools-workflows.html)



### All Commands



For all commands, check out the docs: [www.elven.tools/docs/cli-commands.html](https://www.elven.tools/docs/cli-commands.html)



### Custom configuration options



For all configuration options check out the docs: [www.elven.tools/docs/cli-introduction.html#custom-configuration-options](https://www.elven.tools/docs/cli-introduction.html#custom-configuration-options)



### Most common recipes



Here are ready-to-use recipes and more information on real-life use cases: [Elven Tools Recipes](https://www.elven.tools/docs/recipes.html)



### You may also like



- [Buildo.dev](https://www.buildo.dev) - Buildo.dev is a MultiversX app that helps with blockchain interactions, like issuing tokens and querying smart contracts.

- [elven.js](https://github.com/elven-js/elven.js) - simplified wrapper over JS sdk-core, designed to work as a plug-n-play solution for browser based use cases. No build steps and frameworks, just one file to rule it all! Check usage examples!

- [useElven](https://www.useelven.com) - React hooks for MultiversX

- [NFT Art Maker](https://github.com/juliancwirko/nft-art-maker) - generates images and metadata files and packs them into CAR files, all from provided PNG layers.

- [Buildo Begins](https://github.com/xdevguild/buildo-begins) - CLI toolset for interacting with the MultiversX blockchain, APIs and smart contracts

- [Export collection owners to CSV](https://github.com/ElvenTools/elven-tools-collection-owners-csv)



### Issues and ideas



Please post issues and ideas [here](https://github.com/ElvenTools/elven-tools-cli/issues).



### Contact



- [Twitter](https://twitter.com/theJulianIo)



### License



MIT