Command-Line Help for `snops-agent`

This document contains the help content for the snops-agent command-line program.

Command Overview:

`snops-agent`

Usage: snops-agent [OPTIONS] --id <ID> <COMMAND>

--endpoint <ENDPOINT> — Control plane endpoint address (IP, or wss://host, http://host)
--id <ID> — Agent ID, used to identify the agent in the network
--private-key-file <PRIVATE_KEY_FILE> — Locally provided private key file, used for envs where private keys are locally provided
--labels <LABELS> — Labels to attach to the agent, used for filtering and grouping
--path <PATH> — Path to the directory containing the stored data and configuration

Default value: ./snops-data
--external <EXTERNAL> — Enable the agent to fetch its external address. Necessary to determine which agents are on shared networks, and for external-to-external connections
--internal <INTERNAL> — Manually specify internal addresses
--bind <BIND_ADDR>

Default value: 0.0.0.0
--node <NODE> — Specify the IP address and port for the node server

Default value: 4130
--bft <BFT> — Specify the IP address and port for the BFT

Default value: 5000
--rest <REST> — Specify the IP address and port for the REST server

Default value: 3030
--metrics <METRICS> — Specify the port for the metrics

Default value: 9000
--validator — Enable running a validator node
--prover — Enable running a prover node
--client — Enable running a client node
--compute — Enable functioning as a compute target when inventoried
-q, --quiet — Run the agent in quiet mode, suppressing most node output

Default value: false

For generating cli manpages. Only with the mangen feature enabled

Usage: snops-agent man [DIRECTORY]

<DIRECTORY> — Directory to write manpages to

Default value: target/man/snops-cli

For generating cli markdown. Only with the clipages feature enabled

Usage: snops-agent md [DIRECTORY]

<DIRECTORY> — Directory to write markdown to

Default value: snops_book/user_guide/clis

This document was generated automatically by clap-markdown.