docs: run automated cmd doc generation script

docs/reference/cli-commands/add.md

@@ -0,0 +1,21 @@
+# Add command
+
+The add command reads the plan's layer YAML from the path specified and
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble add --help
+Usage:
+  pebble add [add-OPTIONS] <label> <layer-path>
+
+The add command reads the plan's layer YAML from the path specified and
+appends a layer with the given label to the plan's layers. If --combine
+is specified, combine the layer with an existing layer that has the given
+label (or append if the label is not found).
+
+[add command options]
+      --combine         Combine the new layer with an existing layer that has the given label (default is to append)
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/changes.md

@@ -0,0 +1,18 @@
+# Changes command
+
+The changes command displays a summary of system changes performed recently.
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble changes --help
+Usage:
+  pebble changes [changes-OPTIONS] [<service>]
+
+The changes command displays a summary of system changes performed recently.
+
+[changes command options]
+      --abs-time     Display absolute times (in RFC 3339 format). Otherwise, display relative times up to 60 days, then YYYY-MM-DD.
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/checks.md

@@ -0,0 +1,20 @@
+# Checks command
+
+The checks command lists status information about the configured health
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble checks --help
+Usage:
+  pebble checks [checks-OPTIONS] [<check>...]
+
+The checks command lists status information about the configured health
+checks, optionally filtered by level and check names provided as positional
+arguments.
+
+[checks command options]
+      --level=[alive|ready]   Check level to filter for
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/cli-commands.md

@@ -4,11 +4,31 @@
 :titlesonly:
 :maxdepth: 1
 
-help <help>
-logs <logs>
-replan <replan>
 run <run>
+help <help>
+version <version>
+add <add>
+plan <plan>
 services <services>
+logs <logs>
 start <start>
+restart <restart>
+signal <signal>
 stop <stop>
+replan <replan>
+checks <checks>
+health <health>
+push <push>
+pull <pull>
+ls <ls>
+mkdir <mkdir>
+rm <rm>
+exec <exec>
+changes <changes>
+tasks <tasks>
+warnings <warnings>
+okay <okay>
+notices <notices>
+notice <notice>
+notify <notify>
 ```

docs/reference/cli-commands/exec.md

@@ -0,0 +1,36 @@
+# Exec command
+
+The exec command runs a remote command and waits for it to finish. The local
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble exec --help
+Usage:
+  pebble exec [exec-OPTIONS] <command>
+
+The exec command runs a remote command and waits for it to finish. The local
+stdin is sent as the input to the remote process, while the remote stdout and
+stderr are output locally.
+
+To avoid confusion, exec options may be separated from the command and its
+arguments using "--", for example:
+
+pebble exec --timeout 10s -- echo -n foo bar
+
+[exec command options]
+      -w=              Working directory to run command in
+          --env=       Environment variable to set (in 'FOO=bar' format)
+          --uid=       User ID to run command as
+          --user=      Username to run command as (user's UID must match uid if both present)
+          --gid=       Group ID to run command as
+          --group=     Group name to run command as (group's GID must match gid if both present)
+          --timeout=   Timeout after which to terminate command
+          --context=   Inherit the context of the named service (overridden by -w, --env, --uid/user, --gid/group)
+      -t               Allocate remote pseudo-terminal and connect stdout to it (default if stdout is a TTY)
+      -T               Disable remote pseudo-terminal allocation
+      -i               Interactive mode: connect stdin to the pseudo-terminal (default if stdin and stdout are TTYs)
+      -I               Disable interactive mode and use a pipe for stdin
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/health.md

@@ -0,0 +1,21 @@
+# Health command
+
+The health command queries the health of configured checks.
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble health --help
+Usage:
+  pebble health [health-OPTIONS] [<check>...]
+
+The health command queries the health of configured checks.
+
+It returns an exit code 0 if all the requested checks are healthy, or
+an exit code 1 if at least one of the requested checks are unhealthy.
+
+[health command options]
+      --level=[alive|ready]   Check level to filter for
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/logs.md

@@ -6,8 +6,9 @@ The Pebble daemon's service manager stores the most recent stdout and stderr fro
 
 Logs are viewable via the logs API or using `pebble logs`:
 
+<!-- START AUTOMATED OUTPUT -->
 ```{terminal}
-   :input: pebble logs --help
+:input: pebble logs --help
 Usage:
   pebble logs [logs-OPTIONS] [<service>...]
 
@@ -22,6 +23,7 @@ if none are specified) and displays them in chronological order.
       -n=              Number of logs to show (before following); defaults to 30.
                        If 'all', show all buffered logs.
 ```
+<!-- END AUTOMATED OUTPUT -->
 
 ## Examples
 

docs/reference/cli-commands/ls.md

@@ -0,0 +1,21 @@
+# Ls command
+
+The ls command lists entries in the filesystem at the specified path. A glob pattern
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble ls --help
+Usage:
+  pebble ls [ls-OPTIONS] <path>
+
+The ls command lists entries in the filesystem at the specified path. A glob pattern
+may be specified for the last path element.
+
+[ls command options]
+          --abs-time  Display absolute times (in RFC 3339 format). Otherwise, display relative times up to 60 days, then YYYY-MM-DD.
+      -d              List matching entries themselves, not directory contents
+      -l              Use a long listing format
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/mkdir.md

@@ -0,0 +1,23 @@
+# Mkdir command
+
+The mkdir command creates the specified directory.
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble mkdir --help
+Usage:
+  pebble mkdir [mkdir-OPTIONS] <path>
+
+The mkdir command creates the specified directory.
+
+[mkdir command options]
+      -p            Create parent directories as needed
+      -m=           Override mode bits (3-digit octal)
+          --uid=    Use specified user ID
+          --user=   Use specified username
+          --gid=    Use specified group ID
+          --group=  Use specified group name
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/notice.md

@@ -0,0 +1,19 @@
+# Notice command
+
+The notice command fetches a single notice, either by ID (1-arg variant), or
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble notice --help
+Usage:
+  pebble notice [notice-OPTIONS] <id-or-type> [<key>]
+
+The notice command fetches a single notice, either by ID (1-arg variant), or
+by unique type and key combination (2-arg variant).
+
+[notice command options]
+      --uid=            Look up notice from user with this UID (admin only; 2-arg variant only)
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/notices.md

@@ -0,0 +1,26 @@
+# Notices command
+
+The notices command lists notices not yet acknowledged, ordered by the
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble notices --help
+Usage:
+  pebble notices [notices-OPTIONS]
+
+The notices command lists notices not yet acknowledged, ordered by the
+last-repeated time (oldest first). After it runs, the notices that were shown
+may then be acknowledged by running 'pebble okay'. When a notice repeats, it
+needs to be acknowledged again.
+
+[notices command options]
+      --abs-time    Display absolute times (in RFC 3339 format). Otherwise, display relative times up to 60 days, then YYYY-MM-DD.
+      --users=      Show all notices with any user ID (admin only; cannot be used with --uid)
+      --uid=        Only list notices with this user ID (admin only; cannot be used with --users)
+      --type=       Only list notices of this type (multiple allowed)
+      --key=        Only list notices with this key (multiple allowed)
+      --timeout=    Wait up to this duration for matching notices to arrive
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/notify.md

@@ -0,0 +1,19 @@
+# Notify command
+
+The notify command records a custom notice with the specified key and optional
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble notify --help
+Usage:
+  pebble notify [notify-OPTIONS] <key> [<name=value>...]
+
+The notify command records a custom notice with the specified key and optional
+data fields.
+
+[notify command options]
+      --repeat-after=   Prevent notice with same type and key from reoccurring within this duration
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/okay.md

@@ -0,0 +1,21 @@
+# Okay command
+
+The okay command acknowledges warnings and notices that have been previously
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble okay --help
+Usage:
+  pebble okay [okay-OPTIONS]
+
+The okay command acknowledges warnings and notices that have been previously
+listed using 'pebble warnings' or 'pebble notices', so that they are omitted
+from future runs of either command. When a notice or warning is repeated, it
+will again show up until the next 'pebble okay'.
+
+[okay command options]
+      --warnings    Only acknowledge warnings, not other notices
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/plan.md

@@ -0,0 +1,16 @@
+# Plan command
+
+The plan command prints out the effective configuration of Pebble in YAML
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble plan --help
+Usage:
+  pebble plan
+
+The plan command prints out the effective configuration of Pebble in YAML
+format. Layers are combined according to the override rules defined in them.
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/pull.md

@@ -0,0 +1,15 @@
+# Pull command
+
+The pull command retrieves a file from the remote system.
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble pull --help
+Usage:
+  pebble pull <remote-path> <local-path>
+
+The pull command retrieves a file from the remote system.
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/push.md

@@ -0,0 +1,23 @@
+# Push command
+
+The push command transfers a file to the remote system.
+
+## Usage
+
+<!-- START AUTOMATED OUTPUT -->
+```{terminal}
+:input: pebble push --help
+Usage:
+  pebble push [push-OPTIONS] <local-path> <remote-path>
+
+The push command transfers a file to the remote system.
+
+[push command options]
+      -p                   Create parent directories for the file
+      -m=                  Override mode bits (3-digit octal)
+          --uid=           Use specified user ID
+          --user=          Use specified username
+          --gid=           Use specified group ID
+          --group=         Use specified group name
+```
+<!-- END AUTOMATED OUTPUT -->

docs/reference/cli-commands/replan.md

@@ -4,8 +4,9 @@ The replan command starts, stops, or restarts services that have changed, so tha
 
 ## Usage
 
+<!-- START AUTOMATED OUTPUT -->
 ```{terminal}
-   :input: pebble replan --help
+:input: pebble replan --help
 Usage:
   pebble replan [replan-OPTIONS]
 
@@ -16,6 +17,7 @@ current plan.
 [replan command options]
       --no-wait    Do not wait for the operation to finish but just print the change id.
 ```
+<!-- END AUTOMATED OUTPUT -->
 
 ## How it works