diff --git a/README.md b/README.md new file mode 100644 index 0000000..e9cc6b6 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# `cbctl` + +`cbctl` is a CLI tool for interacting with the Chainbound backend. + +## Installation +With Go: +```bash +go get github.com/chainbound/cbctl +``` + +## Usage +First, initialize `cbctl` with your API key. This will write a config file to `~/.config/cbctl/config.toml`: +```bash +cbctl init --key +``` + +### Fiber Commands +The `fiber` subcommand let's you interact with the Fiber backend. + +* `cbctl fiber quota` +Gets your quota for the current billing period. +* `cbctl fiber trace tx --hash ` +Gets the trace for a transaction. Run `cbctl fiber trace tx --help` for more info.