Browse Source

Merge pull request #759 from tendermint/improve-docs

docs: update abci example details
pull/772/head
Zach 7 years ago
committed by GitHub
parent
commit
4c9d5244a5
2 changed files with 37 additions and 35 deletions
  1. +30
    -20
      docs/abci-cli.rst
  2. +7
    -15
      docs/getting-started.rst

+ 30
- 20
docs/abci-cli.rst View File

@ -14,7 +14,7 @@ Next, install the ``abci-cli`` tool and example applications:
:: ::
go get -u github.com/tendermint/abci/cmd/...
go get -u github.com/tendermint/abci/cmd/abci-cli
If this fails, you may need to use ``glide`` to get vendored If this fails, you may need to use ``glide`` to get vendored
dependencies: dependencies:
@ -24,27 +24,37 @@ dependencies:
go get github.com/Masterminds/glide go get github.com/Masterminds/glide
cd $GOPATH/src/github.com/tendermint/abci cd $GOPATH/src/github.com/tendermint/abci
glide install glide install
go install ./cmd/...
go install ./cmd/abci-cli
Now run ``abci-cli --help`` to see the list of commands:
Now run ``abci-cli`` to see the list of commands:
:: ::
COMMANDS:
batch Run a batch of ABCI commands against an application
console Start an interactive console for multiple commands
echo Have the application echo a message
info Get some info about the application
set_option Set an option on the application
deliver_tx Append a new tx to application
check_tx Validate a tx
commit Get application Merkle root hash
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--address "tcp://127.0.0.1:46658" address of application socket
--help, -h show help
--version, -v print the version
Usage:
abci-cli [command]
Available Commands:
batch Run a batch of abci commands against an application
check_tx Validate a tx
commit Commit the application state and return the Merkle root hash
console Start an interactive abci console for multiple commands
counter ABCI demo example
deliver_tx Deliver a new tx to the application
dummy ABCI demo example
echo Have the application echo a message
help Help about any command
info Get some info about the application
query Query the application state
set_option Set an options on the application
Flags:
--abci string socket or grpc (default "socket")
--address string address of application socket (default "tcp://127.0.0.1:46658")
-h, --help help for abci-cli
-v, --verbose print the command and results as if it were a console session
Use "abci-cli [command] --help" for more information about a command.
Dummy - First Example Dummy - First Example
--------------------- ---------------------
@ -61,7 +71,7 @@ Let's start a dummy application, which was installed at the same time as
:: ::
dummy
abci-cli dummy
In another terminal, run In another terminal, run
@ -181,7 +191,7 @@ app:
:: ::
counter
abci-cli counter
In another window, start the ``abci-cli console``: In another window, start the ``abci-cli console``:


+ 7
- 15
docs/getting-started.rst View File

@ -25,7 +25,7 @@ Then run
:: ::
go get -u github.com/tendermint/abci/cmd/...
go get -u github.com/tendermint/abci/cmd/abci-cli
If there is an error, install and run the ``glide`` tool to pin the If there is an error, install and run the ``glide`` tool to pin the
dependencies: dependencies:
@ -35,20 +35,12 @@ dependencies:
go get github.com/Masterminds/glide go get github.com/Masterminds/glide
cd $GOPATH/src/github.com/tendermint/abci cd $GOPATH/src/github.com/tendermint/abci
glide install glide install
go install ./cmd/...
go install ./cmd/abci-cli
Now you should have the ``abci-cli`` plus two apps installed:
::
dummy --help
counter --help
These binaries are installed on ``$GOPATH/bin`` and all come from within
the ``./cmd/...`` directory of the abci repository.
Both of these example applications are in Go. See below for an
application written in Javascript.
Now you should have the ``abci-cli`` installed; you'll see
a couple of commands (``counter`` and ``dummy``) that are
example applications written in Go. See below for an application
written in Javascript.
Now, let's run some apps! Now, let's run some apps!
@ -66,7 +58,7 @@ Let's start a dummy application.
:: ::
dummy
abci-cli dummy
In another terminal, we can start Tendermint. If you have never run In another terminal, we can start Tendermint. If you have never run
Tendermint before, use: Tendermint before, use:


Loading…
Cancel
Save