List and see status of sites of a collective
sdpctl sites list [<site-id|site-name>]... [flags]
+ sdpctl sites list
List and see status of sites of a collective
Synopsis
List and see status of sites of a collective. By default, configured sites will be shown in a table, but viewing sites in json format is supported using the ‘–json’ flag.
+Text lines that contain multiple lines will be abbreviated to only showing the first line in the table view. In that case, the abbreviated lines will be indicated with ‘[…]’.
+To view the full output, use the ‘–json’ flag.
sdpctl sites list [<site-id|site-name>]... [flags]
Examples
# will list all sites configured in a collective if no arguments are used.
diff --git a/pkg/docs/sites.go b/pkg/docs/sites.go
index 6b88b95f..370af202 100644
--- a/pkg/docs/sites.go
+++ b/pkg/docs/sites.go
@@ -7,6 +7,9 @@ var (
}
SitesListDocs = CommandDoc{
Short: "List and see status of sites of a collective",
+ Long: `List and see status of sites of a collective. By default, configured sites will be shown in a table, but viewing sites in json format is supported using the '--json' flag.
+Text lines that contain multiple lines will be abbreviated to only showing the first line in the table view. In that case, the abbreviated lines will be indicated with '[...]'.
+To view the full output, use the '--json' flag.`,
Examples: []ExampleDoc{
{
Command: "sdpctl sites list",