entropyxyz / cli

CLI utility to ease interactions with an Entropy network.
GNU Affero General Public License v3.0
5 stars 0 forks source link

[design base WIP] cli usage design proposal `man entropy | entropy` #94

Open frankiebee opened 4 weeks ago

frankiebee commented 4 weeks ago

Here is my proposal for the design of the cli:

ENTROPY(1)

NAME

entropy - too smart lazy portal to entropy protocol

SYNOPSIS

entropy [- v | --version] [-d | --dev] [-h | --help] [-i | --interactive] [-e | --endpoint] <comand> [<args>]

DESCRIPTION

Entropy is both a cli and tui for interacting with the entropy protocol.

OPTIONS

-v, --version

Prints the Entropy suite version that the entropy program came from.

-h, --help

Prints the synopsis and a list of the most commonly used commands.

-d, --dev # tui only

shows developer options in the tui for dealing with a local network.

-i, --interactive

this option starts the interactive version of entropy currently only text based user interface (tui) possibly a gui in the future

-e, --endpoint

set the endpoint to work from

COMMANDS

[sudo] entropy-accounts [-v | --verbose] [-h | --help] [<args> address | name] entropy-accounts#ls [-v | --verbose] entropy-accounts#create alias=new entropy-accounts#import alias=add

entropy-balance [-h | --help] [<args> address | name] list balance for a given account if no account is given list balances for all accounts in the config

[sudo] entropy-transfer [-h | --help] [-t | --type transfer_type=allowDeath] [<args> to=address | name, from=address | name]

entropy-register [<args> address | name] entropy-sign [<args> address | name]

entropy-programs entropy-programs#deploy entropy programs deploy entropy-programs#remove --dev=address | name [<args> pointer[| pointers]] entropy-programs#remove -vk | --verifying-key=keyString [<args> pointer[| pointers]] entropy-programs#get --owned entropy-programs#get -vk | --verifying-key=keyString

entropy-programs#set entropy session -vk=[address] entropy programs add pointer file-path-to-config.json entropy programs set config pointer file-path.json entropy programs remove pointer

entropy-session entropy session --info