gex

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

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 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 Ignite.

Install GEX

The GEX installation requires Go. If you don't already have Go installed, see https://golang.ir/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/ignite/gex@latest

Run GEX

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

gex explorer

and hit enter.

Optional Host

Configure an optional host, instead of using the default RPC host http://localhost:26657

gex explorer 192.168.0.1

Optional Port

Configure an optional port

gex explorer 192.168.0.1:27657

Print help

Usage:
  gex [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  explorer    Gex is a cosmos explorer for terminals
  help        Help about any command
  version     Print the current build information

Flags:
  -h, --help   help for gex

Use "gex [command] --help" for more information about a command.

Preview

Terminal Screenshot

Run In Development

To manually run GEX, clone the github.com/ignite/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 explorer

Contribute

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

Thanks for contributing!

Documentation

Overview

Binary explorer demo. Displays widgets for insights of blockchain behaviour. Exist when 'q' or 'esc' is pressed.

Directories

Path Synopsis
pkg
services

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL