Skip to content
/ gex Public

In-terminal explorer for Cosmos SDK blockchains.

License

Notifications You must be signed in to change notification settings

cosmos/gex

Repository files navigation

GEX In-Terminal Gaia Explorer

GEX is a real time in-terminal explorer for Cosmos SDK blockchains. See the Check out your Cosmos SDK blockchain in a terminal-based block explorer blog post to learn more about GEX.

The GEX explorer displays blocks, transactions, validator, network status, and more information. Use the GEX block explorer to see the status of peers, connection, version, and other useful information to have a quick peek into your own node. GEX works with Starport.

Install GEX

The GEX installation requires Go. If you don't already have Go installed, see https://golang.org/dl. Download the binary release that is suitable for your system and follow the installation instructions.

To install the GEX binary:

go install github.com/cosmos/gex@latest

Run GEX

To launch a GEX explorer in your terminal window, type:

gex

and hit enter.

Optional Host

Configure an optional host, instead of using the default RPC host localhost

gex -h 192.168.0.1

Optional Port

Configure an optional port, instead of using the default RPC port 26657

gex -p 27657

Optional Secure Transport

Configure connection to use SSL for HTTP and websockets requests

gex -s

Print help

gex --help
Usage of gex:
  -h string
               host to connect (default "localhost")
  -p int
               port to connect (default 26657)
  -s boolean   
               use SSL for connection

Preview

Terminal Screenshot

Run In Development

To manually run GEX, clone the github.com/cosmos/gex repository and then cd into the gex directory. Then to run GEX manually, type this command in a terminal window:

go run main.go

Contribute

See CONTRIBUTING.md to learn about how to contribute and how the code is structured.

Thanks for contributing!