Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cosmos/gex
In-terminal explorer for Cosmos SDK blockchains.
https://github.com/cosmos/gex
blockchain cosmossdk rpc tendermint websocket
Last synced: about 1 month ago
JSON representation
In-terminal explorer for Cosmos SDK blockchains.
- Host: GitHub
- URL: https://github.com/cosmos/gex
- Owner: cosmos
- License: other
- Created: 2020-10-02T08:00:00.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T14:48:32.000Z (9 months ago)
- Last Synced: 2024-04-14T22:51:10.444Z (8 months ago)
- Topics: blockchain, cosmossdk, rpc, tendermint, websocket
- Language: Go
- Homepage:
- Size: 72.7 MB
- Stars: 93
- Watchers: 8
- Forks: 45
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ccamel - cosmos/gex - In-terminal explorer for Cosmos SDK blockchains. (Go)
- awesome-cosmos - gex - GEX In-Terminal Explorer. (Block Explorers / Terminal Block Explorers)
README
## 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](https://blog.cosmos.network/gaia-explorer-in-terminal-f37a4ea52e3c) 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:
```sh
go install github.com/cosmos/gex@latest
```
## Run GEX
To launch a GEX explorer in your terminal window, type:
```sh
gex
```
and hit enter.
## Optional Host
Configure an optional host, instead of using the default RPC host `localhost`
```sh
gex -h 192.168.0.1
```
## Optional Port
Configure an optional port, instead of using the default RPC port `26657`
```sh
gex -p 27657
```
## Optional Secure Transport
Configure connection to use SSL for HTTP and websockets requests
```sh
gex -s
```
## Print help
```sh
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
## 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](./CONTRIBUTING.md) to learn about how to contribute and how the code is structured.
Thanks for contributing!