peer¶
Description¶
The peer
command has five different subcommands, each of which allows
administrators to perform a specific set of tasks related to a peer. For
example, you can use the peer channel
subcommand to join a peer to a channel,
or the peer chaincode
command to deploy a smart contract chaincode to a
peer.
Syntax¶
The peer
command has five different subcommands within it:
peer chaincode [option] [flags]
peer channel [option] [flags]
peer node [option] [flags]
peer version [option] [flags]
Each subcommand has different options available, and these are described in
their own dedicated topic. For brevity, we often refer to a command (peer
), a
subcommand (channel
), or subcommand option (fetch
) simply as a command.
If a subcommand is specified without an option, then it will return some high
level help text as described in the --help
flag below.
Flags¶
Each peer
subcommand has a specific set of flags associated with it, many of
which are designated global because they can be used in all subcommand
options. These flags are described with the relevant peer
subcommand.
The top level peer
command has the following flag:
--help
Use
--help
to get brief help text for anypeer
command. The--help
flag is very useful – it can be used to get command help, subcommand help, and even option help.For example
peer --help peer channel --help peer channel list --help
See individual
peer
subcommands for more detail.
Usage¶
Here is an example using the available flag on the peer
command.
Using the
--help
flag on thepeer channel join
command.peer channel join --help Joins the peer to a channel. Usage: peer channel join [flags] Flags: -b, --blockpath string Path to file containing genesis block -h, --help help for join Global Flags: --cafile string Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint --certfile string Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint --clientauth Use mutual TLS when communicating with the orderer endpoint --connTimeout duration Timeout for client to connect (default 3s) --keyfile string Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint -o, --orderer string Ordering service endpoint --ordererTLSHostnameOverride string The hostname override to use when validating the TLS connection to the orderer. --tls Use TLS when communicating with the orderer endpoint
This shows brief help syntax for the
peer channel join
command.