Command-Line Help for snops

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

Command Overview:

• snops↴
• snops man↴
• snops md↴

snops

Usage: snops [OPTIONS] <COMMAND>

Subcommands:

• man — For generating cli manpages. Only with the mangen feature enabled
• md — For generating cli markdown. Only with the clipages feature enabled

Options:

• --bind <BIND_ADDR>

  Default value: 0.0.0.0

• --port <PORT> — Control plane server port

  Default value: 1234

• --prometheus <PROMETHEUS> — Optional URL referencing a Prometheus server

• --loki <LOKI> — Optional URL referencing a Loki server

• --prometheus-location <PROMETHEUS_LOCATION>

  Default value: docker

• --path <PATH> — Path to the directory containing the stored data

  Default value: snops-control-data

• --hostname <HOSTNAME> — Hostname to advertise to the control plane, used when resolving the control plane's address for external cannons can be an external IP or FQDN, will have the port appended

  must contain http:// or https://

snops man

For generating cli manpages. Only with the mangen feature enabled

Usage: snops man [DIRECTORY]

Arguments:

• <DIRECTORY> — Directory to write manpages to

  Default value: target/man/snops-cli

snops md

For generating cli markdown. Only with the clipages feature enabled

Usage: snops md [DIRECTORY]

Arguments:

• <DIRECTORY> — Directory to write markdown to

  Default value: snops_book/user_guide/clis

This document was generated automatically by clap-markdown.