From ac3be5e41752c96432518ea684e7c65da0875443 Mon Sep 17 00:00:00 2001 From: Frankie Date: Wed, 12 Jun 2024 08:01:36 -1000 Subject: [PATCH 1/4] fix author & version: 0.0.1 (#99) --- package.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index da2cd977..61d6a07d 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@entropyxyz/cli", - "version": "1.0.0", - "description": "", + "version": "0.0.1", + "description": "cli and tui for interacting with the entropy protocol", "scripts": { "start": "ts-node src/index.ts", "start:debug": "DEBUG=@entropyxyz/cli yarn start", @@ -22,7 +22,7 @@ "url": "git+https://github.com/entropyxyz/cli.git" }, "keywords": [], - "author": "Jesse Abramowitz", + "author": "entropy.xyz", "license": "AGPL-3.0-only", "bugs": { "url": "https://github.com/entropyxyz/cli/issues" From 02ccd4c4793329b2efc16e0ec6f5f85535d15cb8 Mon Sep 17 00:00:00 2001 From: frankie Date: Wed, 12 Jun 2024 08:24:15 -1000 Subject: [PATCH 2/4] go back --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 61d6a07d..b8f0f192 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@entropyxyz/cli", - "version": "0.0.1", + "version": "0.0.0", "description": "cli and tui for interacting with the entropy protocol", "scripts": { "start": "ts-node src/index.ts", From 60235cf832a922e4e322d72579e9c6e374070a0f Mon Sep 17 00:00:00 2001 From: frankie Date: Wed, 12 Jun 2024 08:24:53 -1000 Subject: [PATCH 3/4] 0.0.1 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b8f0f192..61d6a07d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@entropyxyz/cli", - "version": "0.0.0", + "version": "0.0.1", "description": "cli and tui for interacting with the entropy protocol", "scripts": { "start": "ts-node src/index.ts", From 89d45adc11e30075d25ac292f4f2d43ee9d43688 Mon Sep 17 00:00:00 2001 From: Johnny <9611008+johnnymatthews@users.noreply.github.com> Date: Mon, 17 Jun 2024 16:28:57 -0300 Subject: [PATCH 4/4] Improves README for self-surface. (#100) --- README.md | 130 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 86 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index a5dd6e82..b73e9e85 100644 --- a/README.md +++ b/README.md @@ -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 ``` - - - - - - - - - - - - - - - - - - - - - - - - - +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).