From 820284a0f12c1610c6e52bdd4edb27621d7f6efa Mon Sep 17 00:00:00 2001 From: William Banfield Date: Fri, 13 Aug 2021 11:35:07 -0400 Subject: [PATCH] add long description --- cmd/tendermint/commands/inspect.go | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/cmd/tendermint/commands/inspect.go b/cmd/tendermint/commands/inspect.go index 00d01352b..5e767850a 100644 --- a/cmd/tendermint/commands/inspect.go +++ b/cmd/tendermint/commands/inspect.go @@ -19,7 +19,16 @@ import ( // InspectCmd is the command for starting an inspect server. var InspectCmd = &cobra.Command{ Use: "inspect", - Short: "Run an inspect server", + Short: "Run an inspect server for investigating Tendermint state.", + Long: ` + inspect runs a subset of Tendermint's RPC endpoints that are useful for debugging + issues with Tendermint. When the tendermint consensus engine detects inconsistent + state, it will crash the tendermint process. Tendermint will not start up while in this + inconsistent state. + + The inspect command can be used to query the block and state store using Tendermint + RPC calls to debug issues of inconsisent state. + `, RunE: runInspect, }