@entropyxyz/cli

Entropy CLI

A straightforward command-line interface (CLI) tool to showcase how to perform basic Entropy actions.

⚠️ 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.

• Install
• Basic usage
• Support
• Contributions
• License

Install

npm install -g @entropyxyz/cli

Usage

Interactive mode

entropy

This command will bring you to the main menu:

? Select Action (Use arrow keys)
> Manage Accounts
  Balance
  Register
  Sign
  Transfer
  Deploy Program
  User Programs
  Exit

Programmatic mode

entropy balance 5GYvMHuB8J4mpJFCJ7scdR8AXGbT69B2bAqbNxPEa9ZSgEJm

See help on programmatic usage:

entropy --help               # all commands
entropy balance --help       # a specific command

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.

Support

Need help with something? Head over to the Entropy Community repository for support or to raise a ticket →

License

This project is licensed under GNU Affero General Public License v3.0.

Development

Development install

1. Install Node + yarn 1.22.x

• we recommend installing Node with e.g. NVM
• enable yarn by running corepack enable

1. Grab this repository and move into the new directory:

git clone https://github.com/entropyxyz/cli
cd cli

1. Build the CLI with Yarn:

yarn

1. Start the CLI:

For an interactive text user interface:

yarn start

You should now see the main menu:

? Select Action (Use arrow keys)
> Manage Accounts
  Balance
  Register
  Sign
  Transfer
  Deploy Program
  User Programs
  Exit

For programmatic use, see:

yarn start --help

Global install

npm install -g

This will register the entropy bin script globally so that you can run

entropy --help