Skip to content

Commit

Permalink
doc: add README
Browse files Browse the repository at this point in the history
  • Loading branch information
mempirate committed May 5, 2023
1 parent a6f1f7c commit 9097657
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <your_api_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 <tx_hash>`
Gets the trace for a transaction. Run `cbctl fiber trace tx --help` for more info.

0 comments on commit 9097657

Please sign in to comment.