-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improves README for self-surface. (#100)
- Loading branch information
1 parent
60235cf
commit 89d45ad
Showing
1 changed file
with
86 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,113 @@ | ||
| # Entropy CLI | ||
|
|
||
| A straight-forward command-line interface (CLI) tool to showcase how to perform basic Entropy actions. | ||
| A straightforward command-line interface (CLI) tool to showcase how to perform basic Entropy actions. | ||
|
|
||
| > This tool is early development. As such, a lot of things do not work. Feel free to play around with it and report any issues at [github.com/entropyxyz/cli](https://github.com/entropyxyz/cli). | ||
| > This tool is in early development. As such, a lot of things do not work. Feel free to play around with it and report any issues at [github.com/entropyxyz/cli](https://github.com/entropyxyz/cli). | ||
| ## Build and run | ||
| - [Install](#install) | ||
| - [Basic usage](#basic-usage) | ||
| - [Support](#support) | ||
| - [Contributions](#contributions) | ||
| - [License](#license) | ||
|
|
||
| Follow these steps to build and install the CLI: | ||
| ## Install | ||
|
|
||
| 1. Ensure you have the correct Yarn and Node version installed: | ||
| 1. Make sure you've got Yarn 1.22.X installed: | ||
|
|
||
| ``` | ||
| # MacOS | ||
| brew install yarn | ||
| ``` | ||
|
|
||
| ```shell | ||
| # Debian/Ubuntu | ||
| sudo apt install yarn -y | ||
| ``` | ||
|
|
||
| ```shell | ||
| yarn --version && node --version | ||
|
|
||
| # Output example: | ||
| # 1.22.22 | ||
| # v20.9.0 or above | ||
| # Arch | ||
| sudo pacman -S yarn | ||
| ``` | ||
|
|
||
| 1. Grab this repository and move into the new directory: | ||
| 1. Clone the Entropy CLI repository and move into the new directory: | ||
|
|
||
| ```shell | ||
| git clone https://github.com/entropyxyz/cli | ||
| cd cli | ||
| git clone https://github.com/entropyxyz/cli && cd cli | ||
| ``` | ||
|
|
||
| 1. Build the project: | ||
| 1. Build the CLI with Yarn: | ||
|
|
||
| ```plaintext | ||
| ```shell | ||
| yarn | ||
| # yarn install v1.22.22 | ||
| # [1/4] Resolving packages... | ||
| ``` | ||
|
|
||
| 1. Start the CLI with: | ||
| 1. Start the CLI: | ||
|
|
||
| ```shell | ||
| yarn start | ||
| ``` | ||
|
|
||
| <!--### Running --> | ||
| <!----> | ||
| <!--* ```yarn```--> | ||
| <!----> | ||
| <!--* you can add am .env file or input the info when prompted by the cli. --> | ||
| <!----> | ||
| <!--```--> | ||
| <!--ENDPOINT_CHAIN=""--> | ||
| <!--SEED=""--> | ||
| <!--NAME=""--> | ||
| <!--```--> | ||
| <!--* before you start the cli ensure that you're running two chains and two validators. local and remote devnet spinup option coming soon. --> | ||
| <!--* to start the CLI run: --> | ||
| <!--* ```yarn entropy```--> | ||
| <!----> | ||
| <!--The CLI currently has the following options:--> | ||
| <!--1. Entropy Faucet--> | ||
| <!--2. Balance--> | ||
| <!--3. Register--> | ||
| <!--4. Programs--> | ||
| <!--5. Sign--> | ||
| <!--7. Transfer--> | ||
| <!--8. Give Zaps--> | ||
| <!--9. New Entropy Wallet--> | ||
| <!----> | ||
| You should now see the main menu: | ||
|
|
||
| ```output | ||
| ? Select Action (Use arrow keys) | ||
| > Manage Accounts | ||
| Balance | ||
| Register | ||
| Sign | ||
| Transfer | ||
| Deploy Program | ||
| User Programs | ||
| Exit | ||
| ``` | ||
|
|
||
| ## Basic usage | ||
|
|
||
| ### Start the CLI | ||
|
|
||
| Start the CLI by moving to the CLI directory and running `yarn start`: | ||
|
|
||
| ```shell | ||
| cd cli | ||
| yarn start | ||
| ``` | ||
|
|
||
| This command will bring you to the main menu: | ||
|
|
||
| ```output | ||
| ? Select Action (Use arrow keys) | ||
| > Manage Accounts | ||
| Balance | ||
| Register | ||
| Sign | ||
| Transfer | ||
| Deploy Program | ||
| User Programs | ||
| Exit | ||
| ``` | ||
|
|
||
| ### Stop the CLI | ||
|
|
||
| You can stop the CLI by selecting **Exit** from the main menu or pressing `CTRL` + `c`. | ||
|
|
||
| ### Available functions | ||
|
|
||
| | Function | Description | | ||
| | -------- | ----------- | | ||
| | Manage accounts | Create, import, and list your locally stored Entropy accounts. | | ||
| | Balance | Show the balance of any locally stored accounts. | | ||
| | Register | Register a locally stored account with the Entropy network. | | ||
| | Sign | Get a signature from the Entropy network using a locally stored, registered account. | | ||
| | Transfer | Transfer funds from a locally stored account to any other address. | | ||
| | Deploy Program | Deploy a program to the Entropy network using a locally stored account. | | ||
| | User Programs | List the programs stored on the Entropy network by any locally stored accounts. | | ||
|
|
||
| For more instructions on using the CLI, check out [docs.entropy.xyz/reference/cli](https://docs.entropy.xyz/reference/cli). | ||
|
|
||
| ## Support | ||
|
|
||
| Need help with something? [Head over to the Entropy Community repository for support or to raise a ticket →](https://github.com/entropyxyz/community#support) | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under [GNU Affero General Public License v3.0](./LICENSE). |