Skip to content

Commit

Permalink
chore: regenerate cli command reference docs using fixed terminal wid…
Browse files Browse the repository at this point in the history
…th 80
  • Loading branch information
IronCore864 committed Aug 2, 2024
1 parent 7711045 commit d6c9f22
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 35 deletions.
16 changes: 8 additions & 8 deletions docs/reference/cli-commands/exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@ pebble exec --timeout 10s -- echo -n foo bar
-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)
--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)
--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)
--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)
Expand Down
3 changes: 1 addition & 2 deletions docs/reference/cli-commands/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ Logs are viewable via the logs API or using `pebble logs`:
Usage:
pebble logs [logs-OPTIONS] [<service>...]
The logs command fetches buffered logs from the given services (or all
services
The logs command fetches buffered logs from the given services (or all services
if none are specified) and displays them in chronological order.
[logs command options]
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cli-commands/mkdir.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Usage:
The mkdir command creates the specified directory.
[mkdir command options]
-p Create parent directories as needed, and don't fail if
path already exists
-p Create parent directories as needed, and don't fail if path
already exists
-m= Override mode bits (3-digit octal)
--uid= Use specified user ID
--user= Use specified username
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/cli-commands/notices.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ another user's notices.
[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= The only valid value is 'all', which lists 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)
--users= The only valid value is 'all', which lists 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
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cli-commands/notify.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ 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
--repeat-after= Prevent notice with same type and key from reoccurring
within this duration
```
<!-- END AUTOMATED OUTPUT -->

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cli-commands/restart.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Usage:
The restart command restarts the named service(s) in the correct order.
[restart command options]
--no-wait Do not wait for the operation to finish but just print
the change id.
--no-wait Do not wait for the operation to finish but just print the
change id.
```
<!-- END AUTOMATED OUTPUT -->
7 changes: 3 additions & 4 deletions docs/reference/cli-commands/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,16 @@ The run command starts Pebble and runs the configured environment.
Additional arguments may be provided to the service command with the --args
option, which
must be terminated with ";" unless there are no further program options.
These arguments
must be terminated with ";" unless there are no further program options. These
arguments
are appended to the end of the service command, and replace any default
arguments defined
in the service plan. For example:
pebble run --args myservice --port 8080 \; --hold
[run command options]
--create-dirs Create Pebble directory on startup if it doesn't
exist
--create-dirs Create Pebble directory on startup if it doesn't exist
--hold Do not start default services automatically
--http= Start HTTP API listening on this address (e.g.,
":4000")
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cli-commands/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ The start command starts the service with the provided name and
any other services it depends on, in the correct order.
[start command options]
--no-wait Do not wait for the operation to finish but just print
the change id.
--no-wait Do not wait for the operation to finish but just print the
change id.
```
<!-- END AUTOMATED OUTPUT -->

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cli-commands/stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ The stop command stops the service with the provided name and
any other service that depends on it, in the correct order.
[stop command options]
--no-wait Do not wait for the operation to finish but just print
the change id.
--no-wait Do not wait for the operation to finish but just print the
change id.
```
<!-- END AUTOMATED OUTPUT -->

Expand Down
13 changes: 6 additions & 7 deletions docs/reference/cli-commands/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,14 @@ The tasks command displays a summary of tasks associated with an individual
change that happened recently.
[tasks command options]
--abs-time Display absolute times (in RFC 3339 format).
Otherwise, display relative times up to 60 days, then
YYYY-MM-DD.
--abs-time Display absolute times (in RFC 3339 format). Otherwise,
display relative times up to 60 days, then YYYY-MM-DD.
--last= Select last change of given type (install, refresh,
remove, try, auto-refresh, etc.). A question mark at
the end of the type means to do nothing (instead of
remove, try, auto-refresh, etc.). A question mark at the
end of the type means to do nothing (instead of
returning an error) if no change of the given type is
found. Note the question mark could need protecting
from the shell.
found. Note the question mark could need protecting from
the shell.
[tasks command arguments]
<change-id>: Change ID
Expand Down

0 comments on commit d6c9f22

Please sign in to comment.