@entropyxyz/cli
Advanced tools
A straightforward command-line interface (CLI) tool to showcase how to perform basic Entropy actions.
:warning: 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.
npm install --global @entropyxyz/cli
There are two ways to interact with this CLI:
You can use this tool interactively by calling:
entropy tui
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
To exit this text-based user interface anytime, press CTRL + c.
You can interact with the Entropy network using the CLI's programmatic mode. Simply call the entropy executable followed by the command you wish to use:
entropy balance 5GYvMHuB8J4mpJFCJ7scdR8AXGbT69B2bAqbNxPEa9ZSgEJm
For more information on the commands available, see the CLI documentation.
Use the help command to get information on what commands are available and what specific options or arguments they require:
General help:
entropy --help
Usage: entropy [options] [command]
CLI interface for interacting with entropy.xyz.
Options:
-v, --version Displays the current running version of Entropy CLI
-cv, --core-version Displays the current running version of the Entropy Protocol
-h, --help display help for command
Commands:
tui [options] Text-based User Interface (interactive)
account Commands to work with accounts on the Entropy Network
sign [options] <msg> Sign a message using the Entropy network. Output is a JSON {
verifyingKey, signature }
balance [options] <account> Command to retrieive the balance of an account on the Entropy
Network
transfer [options] <destination> <amount> Transfer funds between two Entropy accounts.
program Commands for working with programs deployed to the Entropy
Network
Command-specific help:
entropy balance --help
Usage: entropy balance [options] <account>
Command to retrieive the balance of an account on the Entropy Network
Arguments:
account The address an account address whose balance you want to query. Can also be the human-readable name of
one of your accounts
Options:
-e, --endpoint <url> Runs entropy with the given endpoint and ignores network endpoints in config. Can also be given a
stored endpoint name from config eg: `entropy --endpoint test-net`. (default:
"wss://testnet.entropy.xyz/", env: ENTROPY_ENDPOINT)
-h, --help display help for command
| 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 CLI instructions, check out docs.entropy.xyz/reference/cli.
All changes to this repo should be based off the dev branch. The main branch should not be directly edited, unless a hotfix is necessary. All PRs should follow this workflow:
feature_branch -> dev -> main
If you want to make changes to this CLI tool, you should install it by following these steps:
Ensure you have Node.js version 20.9.0 or above and Yarn version 1.22.22 installed:
node --version && yarn --version
v22.2.0
1.22.22
Clone the Entropy CLI repository and move into the new cli directory:
git clone https://github.com/entropyxyz/cli
cd cli
Use Yarn to install the dependencies and build the project.
yarn
This command pulls in the necessary packages and builds the CLI locally.
Start the CLI:
For an interactive text user interface:
yarn start tui
You should now see the main menu:
? Select Action (Use arrow keys)
❯ Manage Accounts
Entropy Faucet
Balance
Register
Sign
Transfer
Deploy Program
User Programs
Exit
For programmatic use, see:
yarn start --help
...
Usage: entropy [options] [command]
CLI interface for interacting with entropy.xyz.
Options:
-v, --version Displays the current running version of Entropy CLI
-cv, --core-version Displays the current running version of the Entropy Protocol
-h, --help display help for command
Commands:
tui [options] Text-based User Interface (interactive)
account Commands to work with accounts on the Entropy Network
sign [options] <msg> Sign a message using the Entropy network. Output is a JSON {
verifyingKey, signature }
balance [options] <account> Command to retrieive the balance of an account on the Entropy
Network
transfer [options] <destination> <amount> Transfer funds between two Entropy accounts.
program Commands for working with programs deployed to the Entropy
Network
Done in 2.16s.
You can see more detail on specific commands using --help e.g.
entropy transfer --help
Need help with something? Head over to the Entropy Community repository for support or to raise a ticket →
This project is licensed under GNU Affero General Public License v3.0.
[0.1.1] Deadpool - 2024-11-06 (entropy-core compatibility: 0.3.0)
FAQs
cli and tui for interacting with the entropy protocol
The npm package @entropyxyz/cli receives a total of 5 weekly downloads. As such, @entropyxyz/cli popularity was classified as not popular.
We found that @entropyxyz/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.