From d304ee02f784a5ad6d6467a6f3960ea55b9ddc7f Mon Sep 17 00:00:00 2001 From: tschettervictor <85497460+tschettervictor@users.noreply.github.com> Date: Tue, 29 Apr 2025 07:51:17 -0600 Subject: [PATCH] docs: Update list --- docs/chapters/subcommands/list.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/chapters/subcommands/list.rst b/docs/chapters/subcommands/list.rst index 860647bc..fb5a1196 100644 --- a/docs/chapters/subcommands/list.rst +++ b/docs/chapters/subcommands/list.rst @@ -1,16 +1,19 @@ list ==== -List jails, ports, releases, templates, logs, limits, exports and imports +List jails, ports, releases, templates, logs, limits, exports and imports and much more managed by bastille. +Using `bastille list` without args will print with all the info we feel is most important. + +Most options can be printed in JSON format by including the `-j|--json` flag. + .. code-block:: shell ishmael ~ # bastille list help - Usage: bastille list [option(s)] [-j|-a] [RELEASE (-p)|template|jails|logs|limits|imports|exports|backups] + Usage: bastille list [option(s)] [RELEASE (-p)] [all] [backup(s)] [export(s)] [import(s)] [ip(s)] [jail(s)] [limit(s)] [log(s)]" + [path(s)] [port(s)] [prio|priority] [state(s)] [template(s)]" Options: - -a | --all List all jails, running and stopped, in BastilleBSD format. - -j | --json List jails in json format. + -j | --json List jails or sub-arg(s) in json format. -x | --debug Enable debug mode. -