diff --git a/.gitignore b/.gitignore index d9dd8a3..93824e9 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,5 @@ __pycache__ *.egg-info build/ *.pyc +.venv +.clicada \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..3b31a53 --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +## Clicada + +> Admin Command Line Interface to interact with cic-meta and cic-cache + +### Pre-requisites + +- Public key uploaded to `cic-auth-helper` +- PGP Keyring for your key + +### Installation + +Use either of the following installation methods: + +1. Install from git release (recommended) + +```bash +wget https://git.grassecon.net/grassrootseconomics/clicada/archive/v0.0.6.zip +unzip clicada-v0.0.6.zip +cd clicada +python3 -m venv .venv +source .venv/bin/activate +pip install -r requirements.txt --extra-index-url=https://pip.grassrootseconomics.net +``` + +2. Install from pip to path (non sudo) + +```bash +pip3 install -UI --extra-index-url=https://pip.grassrootseconomics.net clicada +``` + +### Usage + +```bash +usage: clicada [...optional arguments] [...positional arguments] + +positional arguments: + {user,u,tag,t} + user (u) retrieve transactions for a user + tag (t) locally assign a display value to an identifier + +optional arguments: + -h, --help show this help message and exit + --no-logs Turn off all logging + -v Be verbose + -vv Be very verbose + -c CONFIG, --config CONFIG + Configuration directory + -n NAMESPACE, --namespace NAMESPACE + Configuration namespace + --dumpconfig {env,ini} + Output configuration and quit. Use with --raw to omit values and output schema only. + --env-prefix ENV_PREFIX + environment prefix for variables to overwrite configuration + -p P, --rpc-provider P + RPC HTTP(S) provider url + --rpc-dialect RPC_DIALECT + RPC HTTP(S) backend dialect + --height HEIGHT Block height to execute against + -i I, --chain-spec I Chain specification string + -u, --unsafe Do not verify address checksums + --seq Use sequential rpc ids + -y Y, --key-file Y Keystore file to use for signing or address + --raw Do not decode output + --fee-price FEE_PRICE + override fee price + --fee-limit FEE_LIMIT + override fee limit + +```