diff --git a/cmd/finch/doc.TEMPLATE b/cmd/finch/doc.TEMPLATE index abd394745..9a0c7c264 100644 --- a/cmd/finch/doc.TEMPLATE +++ b/cmd/finch/doc.TEMPLATE @@ -6,7 +6,7 @@ {{.Properties}} -{{end}}```bash +{{end}}```text {{ .Usage }} ```{{if gt (len .Aliases) 0}} @@ -22,13 +22,13 @@ ## Commands -```bash +```text {{ .Commands }} ```{{end}}{{if gt (len .Options) 0}} ## Options -```bash +```text {{ .Options }} ```{{end}}{{if gt (len .SeeAlso) 0}} diff --git a/cmd/finch/gen_docs.go b/cmd/finch/gen_docs.go index d6d7f9f73..4aa0f9330 100644 --- a/cmd/finch/gen_docs.go +++ b/cmd/finch/gen_docs.go @@ -103,7 +103,7 @@ func (gd *genDocsAction) run(outDir string) error { func (gd *genDocsAction) captureHelpOutput(cmd *cobra.Command, outDir string) error { for _, c := range cmd.Commands() { if err := gd.captureHelpOutput(c, outDir); err != nil { - return err + return fmt.Errorf("error while generating docs for %s: %w", c.CommandPath(), err) } } @@ -150,6 +150,10 @@ func (gd *genDocsAction) captureHelpOutput(cmd *cobra.Command, outDir string) er return fmt.Errorf("error while reading stdout from pipe: %w", err) } + // Link to parent command page if parent command is also runnable. + // For example, if `finch vm` and `finch vm init` both had their own Run/RunE methods defined, + // finch vm init's documentation page would link to finch vm's page. + // If this condition is not met, then there is no "SEE ALSO" section. seeAlso := "" if cmd.HasParent() && cmd.Parent().Runnable() { parentName := cmd.Parent().CommandPath() diff --git a/cmd/finch/gen_docs_test.go b/cmd/finch/gen_docs_test.go index 9f4668860..5d5905127 100644 --- a/cmd/finch/gen_docs_test.go +++ b/cmd/finch/gen_docs_test.go @@ -95,7 +95,7 @@ func TestGenDocsAction_runAdapter(t *testing.T) { require.NoError(t, err) require.Equal(t, string(buf), fmt.Sprintf(`# test-command -%sbash +%stext test-command [flags] %s `, codeBlock, codeBlock)) diff --git a/docs/cmd/finch_build.md b/docs/cmd/finch_build.md index 89f9bfe71..02213dfa7 100644 --- a/docs/cmd/finch_build.md +++ b/docs/cmd/finch_build.md @@ -3,13 +3,13 @@ Build an image from a Dockerfile. Needs buildkitd to be running. If Dockerfile is not present and -f is not specified, it will look for Containerfile and build with it. -```bash +```text finch build [flags] PATH ``` ## Options -```bash +```text --build-arg stringArray Set build-time variables --buildkit-host string BuildKit address [$BUILDKIT_HOST] (default "unix:///run/buildkit/buildkitd.sock") --cache-from stringArray External cache sources (eg. user/app:cache, type=local,src=path/to/dir) diff --git a/docs/cmd/finch_builder.md b/docs/cmd/finch_builder.md index f0ac022c2..f184efa3e 100644 --- a/docs/cmd/finch_builder.md +++ b/docs/cmd/finch_builder.md @@ -2,13 +2,13 @@ Manage builds -```bash +```text finch builder [flags] ``` ## Commands -```bash +```text build Build an image from a Dockerfile. Needs buildkitd to be running. debug Debug Dockerfile prune Clean up BuildKit build cache @@ -16,6 +16,6 @@ finch builder [flags] ## Options -```bash +```text -h, --help help for builder ``` diff --git a/docs/cmd/finch_commit.md b/docs/cmd/finch_commit.md index 0cc4e557a..a1af07dcc 100644 --- a/docs/cmd/finch_commit.md +++ b/docs/cmd/finch_commit.md @@ -2,13 +2,13 @@ Create a new image from a container's changes -```bash +```text finch commit [flags] CONTAINER REPOSITORY[:TAG] ``` ## Options -```bash +```text -a, --author string Author (e.g., "finch contributor ") -c, --change stringArray Apply Dockerfile instruction to the created image (supported directives: [CMD, ENTRYPOINT]) -h, --help help for commit diff --git a/docs/cmd/finch_completion_bash.md b/docs/cmd/finch_completion_bash.md index 7fb5e5451..f23daf008 100644 --- a/docs/cmd/finch_completion_bash.md +++ b/docs/cmd/finch_completion_bash.md @@ -13,13 +13,13 @@ To load completions for every new session, execute once: #### -```bash +```text finch completion bash ``` ## Options -```bash +```text -h, --help help for bash --no-descriptions disable completion descriptions ``` diff --git a/docs/cmd/finch_completion_fish.md b/docs/cmd/finch_completion_fish.md index 30e23193f..7bd00d9f9 100644 --- a/docs/cmd/finch_completion_fish.md +++ b/docs/cmd/finch_completion_fish.md @@ -12,13 +12,13 @@ To load completions for every new session, execute once: You will need to start a new shell for this setup to take effect. -```bash +```text finch completion fish [flags] ``` ## Options -```bash +```text -h, --help help for fish --no-descriptions disable completion descriptions ``` diff --git a/docs/cmd/finch_completion_powershell.md b/docs/cmd/finch_completion_powershell.md index d9c4962f6..2665ec6b4 100644 --- a/docs/cmd/finch_completion_powershell.md +++ b/docs/cmd/finch_completion_powershell.md @@ -9,13 +9,13 @@ To load completions in your current shell session: To load completions for every new session, add the output of the above command to your powershell profile. -```bash +```text finch completion powershell [flags] ``` ## Options -```bash +```text -h, --help help for powershell --no-descriptions disable completion descriptions ``` diff --git a/docs/cmd/finch_completion_zsh.md b/docs/cmd/finch_completion_zsh.md index 1dcfec26e..0ad834d53 100644 --- a/docs/cmd/finch_completion_zsh.md +++ b/docs/cmd/finch_completion_zsh.md @@ -15,13 +15,13 @@ To load completions for every new session, execute once: #### -```bash +```text finch completion zsh [flags] ``` ## Options -```bash +```text -h, --help help for zsh --no-descriptions disable completion descriptions ``` diff --git a/docs/cmd/finch_compose.md b/docs/cmd/finch_compose.md index 66b5ba895..1b6925380 100644 --- a/docs/cmd/finch_compose.md +++ b/docs/cmd/finch_compose.md @@ -2,13 +2,13 @@ Compose -```bash +```text finch compose [flags] COMMAND ``` ## Commands -```bash +```text build Build or rebuild services config Validate and view the Compose file cp Copy files/folders between a service container and the local filesystem @@ -36,7 +36,7 @@ finch compose [flags] COMMAND ## Options -```bash +```text --env-file string Specify an alternate environment file -f, --f stringArray Alias of --file --file stringArray Specify an alternate compose file diff --git a/docs/cmd/finch_container.md b/docs/cmd/finch_container.md index c77cced57..3aa6daa16 100644 --- a/docs/cmd/finch_container.md +++ b/docs/cmd/finch_container.md @@ -2,13 +2,13 @@ Manage containers -```bash +```text finch container [flags] ``` ## Commands -```bash +```text attach Attach stdin, stdout, and stderr to a running container. commit Create a new image from a container's changes cp Copy files/folders between a running container and the local filesystem. @@ -35,6 +35,6 @@ finch container [flags] ## Options -```bash +```text -h, --help help for container ``` diff --git a/docs/cmd/finch_cp.md b/docs/cmd/finch_cp.md index 263b2a7de..cc82dfb55 100644 --- a/docs/cmd/finch_cp.md +++ b/docs/cmd/finch_cp.md @@ -5,14 +5,14 @@ This command requires 'tar' to be installed on the host (not in the container). Using GNU tar is recommended. The path of the 'tar' binary can be specified with an environment variable '$TAR'. -```bash +```text finch cp [flags] CONTAINER:SRC_PATH DEST_PATH|- finch cp [flags] SRC_PATH|- CONTAINER:DEST_PATH ``` ## Options -```bash +```text -L, --follow-link Always follow symbolic link in SRC_PATH. -h, --help help for cp ``` diff --git a/docs/cmd/finch_create.md b/docs/cmd/finch_create.md index 983ffb89f..8aabc79f6 100644 --- a/docs/cmd/finch_create.md +++ b/docs/cmd/finch_create.md @@ -2,13 +2,13 @@ Create a new container. Optionally specify "ipfs://" or "ipns://" scheme to pull image from IPFS. -```bash +```text finch create [flags] IMAGE [COMMAND] [ARG...] ``` ## Options -```bash +```text --add-host strings Add a custom host-to-IP mapping (host:ip) --blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) --cap-add strings Add Linux capabilities diff --git a/docs/cmd/finch_events.md b/docs/cmd/finch_events.md index a0ab9b377..e061afcf3 100644 --- a/docs/cmd/finch_events.md +++ b/docs/cmd/finch_events.md @@ -2,13 +2,13 @@ Get real time events from the server -```bash +```text finch events [flags] ``` ## Options -```bash +```text --format string Format the output using the given Go template, e.g, '{{json .}}' -h, --help help for events ``` diff --git a/docs/cmd/finch_exec.md b/docs/cmd/finch_exec.md index 3b1493ce4..d5f3c09b9 100644 --- a/docs/cmd/finch_exec.md +++ b/docs/cmd/finch_exec.md @@ -2,13 +2,13 @@ Run a command in a running container -```bash +```text finch exec [flags] CONTAINER COMMAND [ARG...] ``` ## Options -```bash +```text -d, --detach Detached mode: run command in the background -e, --env stringArray Set environment variables --env-file strings Set environment variables from file diff --git a/docs/cmd/finch_help.md b/docs/cmd/finch_help.md index 04ab36660..f70168002 100644 --- a/docs/cmd/finch_help.md +++ b/docs/cmd/finch_help.md @@ -3,12 +3,12 @@ Help provides help for any command in the application. Simply type finch help [path to command] for full details. -```bash +```text finch help [command] [flags] ``` ## Options -```bash +```text -h, --help help for help ``` diff --git a/docs/cmd/finch_history.md b/docs/cmd/finch_history.md index 5b3585bd3..a7be4cfb6 100644 --- a/docs/cmd/finch_history.md +++ b/docs/cmd/finch_history.md @@ -2,13 +2,13 @@ Show the history of an image -```bash +```text finch history [flags] IMAGE ``` ## Options -```bash +```text -f, --format string Format the output using the given Go template, e.g, '{{json .}}' -h, --help help for history --no-trunc Don't truncate output diff --git a/docs/cmd/finch_image.md b/docs/cmd/finch_image.md index 5a81c0ee8..65463aa1f 100644 --- a/docs/cmd/finch_image.md +++ b/docs/cmd/finch_image.md @@ -2,13 +2,13 @@ Manage images -```bash +```text finch image [flags] ``` ## Commands -```bash +```text build Build an image from a Dockerfile. Needs buildkitd to be running. convert convert an image decrypt decrypt an image @@ -27,6 +27,6 @@ finch image [flags] ## Options -```bash +```text -h, --help help for image ``` diff --git a/docs/cmd/finch_images.md b/docs/cmd/finch_images.md index bc3117cf6..e8afd62d5 100644 --- a/docs/cmd/finch_images.md +++ b/docs/cmd/finch_images.md @@ -13,13 +13,13 @@ List images - SIZE: Size of the unpacked snapshots - BLOB SIZE: Size of the blobs (such as layer tarballs) in the content store -```bash +```text finch images [flags] [REPOSITORY[:TAG]] ``` ## Options -```bash +```text -a, --all (unimplemented yet, always true) (default true) --digests Show digests (compatible with Docker, unlike ID) -f, --filter strings Filter output based on conditions provided diff --git a/docs/cmd/finch_info.md b/docs/cmd/finch_info.md index 653cc3e5e..d86ec8cb8 100644 --- a/docs/cmd/finch_info.md +++ b/docs/cmd/finch_info.md @@ -2,13 +2,13 @@ Display system-wide information -```bash +```text finch info [flags] ``` ## Options -```bash +```text -f, --format string Format the output using the given Go template, e.g, '{{json .}}' -h, --help help for info --mode string Information mode, "dockercompat" for Docker-compatible output, "native" for containerd-native output (default "dockercompat") diff --git a/docs/cmd/finch_inspect.md b/docs/cmd/finch_inspect.md index f3257e2b3..758a4177a 100644 --- a/docs/cmd/finch_inspect.md +++ b/docs/cmd/finch_inspect.md @@ -2,13 +2,13 @@ Return low-level information on objects. -```bash +```text finch inspect [flags] ``` ## Options -```bash +```text -f, --format string Format the output using the given Go template, e.g, '{{json .}}' -h, --help help for inspect --mode string Inspect mode, "dockercompat" for Docker-compatible output, "native" for containerd-native output (default "dockercompat") diff --git a/docs/cmd/finch_kill.md b/docs/cmd/finch_kill.md index c645333fa..536fcc44c 100644 --- a/docs/cmd/finch_kill.md +++ b/docs/cmd/finch_kill.md @@ -2,13 +2,13 @@ Kill one or more running containers -```bash +```text finch kill [flags] CONTAINER [CONTAINER, ...] ``` ## Options -```bash +```text -h, --help help for kill -s, --signal string Signal to send to the container (default "KILL") ``` diff --git a/docs/cmd/finch_load.md b/docs/cmd/finch_load.md index d28f92219..d60dfc636 100644 --- a/docs/cmd/finch_load.md +++ b/docs/cmd/finch_load.md @@ -2,13 +2,13 @@ Supports both Docker Image Spec v1.2 and OCI Image Spec v1.0. -```bash +```text finch load [flags] ``` ## Options -```bash +```text --all-platforms Import content for all platforms -h, --help help for load -i, --input string Read from tar archive file, instead of STDIN diff --git a/docs/cmd/finch_login.md b/docs/cmd/finch_login.md index 2c5cea091..d8ca14965 100644 --- a/docs/cmd/finch_login.md +++ b/docs/cmd/finch_login.md @@ -2,13 +2,13 @@ Log in to a container registry -```bash +```text finch login [flags] [SERVER] ``` ## Options -```bash +```text -h, --help help for login -p, --password string Password --password-stdin Take the password from stdin diff --git a/docs/cmd/finch_logout.md b/docs/cmd/finch_logout.md index 49bb55860..39346977c 100644 --- a/docs/cmd/finch_logout.md +++ b/docs/cmd/finch_logout.md @@ -2,12 +2,12 @@ Log out from a container registry -```bash +```text finch logout [flags] [SERVER] ``` ## Options -```bash +```text -h, --help help for logout ``` diff --git a/docs/cmd/finch_logs.md b/docs/cmd/finch_logs.md index a5725161b..39efc2773 100644 --- a/docs/cmd/finch_logs.md +++ b/docs/cmd/finch_logs.md @@ -7,13 +7,13 @@ The following containers are supported: - Containers created with 'finch compose'. - Containers created with Kubernetes (EXPERIMENTAL). -```bash +```text finch logs [flags] CONTAINER ``` ## Options -```bash +```text -f, --follow Follow log output -h, --help help for logs --since string Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) diff --git a/docs/cmd/finch_network.md b/docs/cmd/finch_network.md index e69f7c06a..1fb3b0415 100644 --- a/docs/cmd/finch_network.md +++ b/docs/cmd/finch_network.md @@ -2,13 +2,13 @@ Manage networks -```bash +```text finch network [flags] ``` ## Commands -```bash +```text create Create a network inspect Display detailed information on one or more networks ls List networks @@ -18,6 +18,6 @@ finch network [flags] ## Options -```bash +```text -h, --help help for network ``` diff --git a/docs/cmd/finch_pause.md b/docs/cmd/finch_pause.md index d7c0b35e3..13231d848 100644 --- a/docs/cmd/finch_pause.md +++ b/docs/cmd/finch_pause.md @@ -2,12 +2,12 @@ Pause all processes within one or more containers -```bash +```text finch pause [flags] CONTAINER [CONTAINER, ...] ``` ## Options -```bash +```text -h, --help help for pause ``` diff --git a/docs/cmd/finch_port.md b/docs/cmd/finch_port.md index cc6382e6e..94ba2d781 100644 --- a/docs/cmd/finch_port.md +++ b/docs/cmd/finch_port.md @@ -2,12 +2,12 @@ List port mappings or a specific mapping for the container -```bash +```text finch port [flags] CONTAINER [PRIVATE_PORT[/PROTO]] ``` ## Options -```bash +```text -h, --help help for port ``` diff --git a/docs/cmd/finch_ps.md b/docs/cmd/finch_ps.md index 076fcb269..a4dda03dd 100644 --- a/docs/cmd/finch_ps.md +++ b/docs/cmd/finch_ps.md @@ -2,13 +2,13 @@ List containers -```bash +```text finch ps [flags] ``` ## Options -```bash +```text -a, --all Show all containers (default shows just running) -f, --filter strings Filter matches containers based on given conditions --format string Format the output using the given Go template, e.g, '{{json .}}', 'wide' diff --git a/docs/cmd/finch_pull.md b/docs/cmd/finch_pull.md index 2d6a7dee9..7c5b0366b 100644 --- a/docs/cmd/finch_pull.md +++ b/docs/cmd/finch_pull.md @@ -2,13 +2,13 @@ Pull an image from a registry. Optionally specify "ipfs://" or "ipns://" scheme to pull image from IPFS. -```bash +```text finch pull [flags] NAME[:TAG] ``` ## Options -```bash +```text --all-platforms Pull content for all platforms --cosign-certificate-identity string The identity expected in a valid Fulcio certificate for --verify=cosign. Valid values include email address, DNS names, IP addresses, and URIs. Either --cosign-certificate-identity or --cosign-certificate-identity-regexp must be set for keyless flows --cosign-certificate-identity-regexp string A regular expression alternative to --cosign-certificate-identity for --verify=cosign. Accepts the Go regular expression syntax described at https://golang.org/s/re2syntax. Either --cosign-certificate-identity or --cosign-certificate-identity-regexp must be set for keyless flows diff --git a/docs/cmd/finch_push.md b/docs/cmd/finch_push.md index 7896d8191..e2ba4a661 100644 --- a/docs/cmd/finch_push.md +++ b/docs/cmd/finch_push.md @@ -2,13 +2,13 @@ Push an image or a repository to a registry. Optionally specify "ipfs://" or "ipns://" scheme to push image to IPFS. -```bash +```text finch push [flags] NAME[:TAG] ``` ## Options -```bash +```text --all-platforms Push content for all platforms --allow-nondistributable-artifacts Allow pushing images with non-distributable blobs --cosign-key string Path to the private key file, KMS URI or Kubernetes Secret for --sign=cosign diff --git a/docs/cmd/finch_restart.md b/docs/cmd/finch_restart.md index d2a78d56d..78881a81a 100644 --- a/docs/cmd/finch_restart.md +++ b/docs/cmd/finch_restart.md @@ -2,13 +2,13 @@ Restart one or more running containers -```bash +```text finch restart [flags] CONTAINER [CONTAINER, ...] ``` ## Options -```bash +```text -h, --help help for restart -t, --time uint Seconds to wait for stop before killing it (default 10) ``` diff --git a/docs/cmd/finch_rm.md b/docs/cmd/finch_rm.md index 9404ae1b3..a99986707 100644 --- a/docs/cmd/finch_rm.md +++ b/docs/cmd/finch_rm.md @@ -2,13 +2,13 @@ Remove one or more containers -```bash +```text finch rm [flags] CONTAINER [CONTAINER, ...] ``` ## Options -```bash +```text -f, --force Force the removal of a running|paused|unknown container (uses SIGKILL) -h, --help help for rm -v, --volumes Remove volumes associated with the container diff --git a/docs/cmd/finch_rmi.md b/docs/cmd/finch_rmi.md index 3e04f6308..a9e6bbad0 100644 --- a/docs/cmd/finch_rmi.md +++ b/docs/cmd/finch_rmi.md @@ -2,13 +2,13 @@ Remove one or more images -```bash +```text finch rmi [flags] IMAGE [IMAGE, ...] ``` ## Options -```bash +```text --async Asynchronous mode -f, --force Force removal of the image -h, --help help for rmi diff --git a/docs/cmd/finch_run.md b/docs/cmd/finch_run.md index 859471167..79f004e8a 100644 --- a/docs/cmd/finch_run.md +++ b/docs/cmd/finch_run.md @@ -2,13 +2,13 @@ Run a command in a new container. Optionally specify "ipfs://" or "ipns://" scheme to pull image from IPFS. -```bash +```text finch run [flags] IMAGE [COMMAND] [ARG...] ``` ## Options -```bash +```text --add-host strings Add a custom host-to-IP mapping (host:ip) --blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) --cap-add strings Add Linux capabilities diff --git a/docs/cmd/finch_save.md b/docs/cmd/finch_save.md index 088a20c2e..15e78e4b4 100644 --- a/docs/cmd/finch_save.md +++ b/docs/cmd/finch_save.md @@ -2,13 +2,13 @@ The archive implements both Docker Image Spec v1.2 and OCI Image Spec v1.0. -```bash +```text finch save [flags] ``` ## Options -```bash +```text --all-platforms Export content for all platforms -h, --help help for save -o, --output string Write to a file, instead of STDOUT diff --git a/docs/cmd/finch_start.md b/docs/cmd/finch_start.md index f1eb11d87..fa70a3ea2 100644 --- a/docs/cmd/finch_start.md +++ b/docs/cmd/finch_start.md @@ -2,13 +2,13 @@ Start one or more running containers -```bash +```text finch start [flags] CONTAINER [CONTAINER, ...] ``` ## Options -```bash +```text -a, --attach Attach STDOUT/STDERR and forward signals --detach-keys string Override the default detach keys (default "ctrl-p,ctrl-q") -h, --help help for start diff --git a/docs/cmd/finch_stats.md b/docs/cmd/finch_stats.md index b4717ca88..93b8c8bfb 100644 --- a/docs/cmd/finch_stats.md +++ b/docs/cmd/finch_stats.md @@ -2,13 +2,13 @@ Display a live stream of container(s) resource usage statistics. -```bash +```text finch stats [flags] ``` ## Options -```bash +```text -a, --all Show all containers (default shows just running) --format string Pretty-print images using a Go template, e.g, '{{json .}}' -h, --help help for stats diff --git a/docs/cmd/finch_stop.md b/docs/cmd/finch_stop.md index bdde5d9f5..5800177f3 100644 --- a/docs/cmd/finch_stop.md +++ b/docs/cmd/finch_stop.md @@ -2,13 +2,13 @@ Stop one or more running containers -```bash +```text finch stop [flags] CONTAINER [CONTAINER, ...] ``` ## Options -```bash +```text -h, --help help for stop -t, --time int Seconds to wait before sending a SIGKILL (default 10) ``` diff --git a/docs/cmd/finch_support-bundle_generate.md b/docs/cmd/finch_support-bundle_generate.md index a3bc64567..e2974168f 100644 --- a/docs/cmd/finch_support-bundle_generate.md +++ b/docs/cmd/finch_support-bundle_generate.md @@ -2,13 +2,13 @@ Generates a collection of logs and configs that can be uploaded to a Github issue to help debug issues. -```bash +```text finch support-bundle generate [flags] ``` ## Options -```bash +```text --exclude stringArray files to exclude from the support bundle. if you specify a base name, all files matching that base name will be excluded. if you specify an absolute or relative path, only exact matches will be excluded -h, --help help for generate --include stringArray additional files to include in the support bundle, specified by absolute or relative path. to include a file from the VM, prefix the file path with "vm:" diff --git a/docs/cmd/finch_system.md b/docs/cmd/finch_system.md index 303cf84a6..30783bc2b 100644 --- a/docs/cmd/finch_system.md +++ b/docs/cmd/finch_system.md @@ -2,13 +2,13 @@ Manage containerd -```bash +```text finch system [flags] ``` ## Commands -```bash +```text events Get real time events from the server info Display system-wide information prune Remove unused data @@ -16,6 +16,6 @@ finch system [flags] ## Options -```bash +```text -h, --help help for system ``` diff --git a/docs/cmd/finch_tag.md b/docs/cmd/finch_tag.md index 5498d99b4..9afa9abbc 100644 --- a/docs/cmd/finch_tag.md +++ b/docs/cmd/finch_tag.md @@ -2,12 +2,12 @@ Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE -```bash +```text finch tag [flags] SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG] ``` ## Options -```bash +```text -h, --help help for tag ``` diff --git a/docs/cmd/finch_top.md b/docs/cmd/finch_top.md index 76cdf59be..207800903 100644 --- a/docs/cmd/finch_top.md +++ b/docs/cmd/finch_top.md @@ -2,12 +2,12 @@ Display the running processes of a container -```bash +```text finch top CONTAINER [ps OPTIONS] [flags] ``` ## Options -```bash +```text -h, --help help for top ``` diff --git a/docs/cmd/finch_unpause.md b/docs/cmd/finch_unpause.md index aa7de0fb0..3ed37619a 100644 --- a/docs/cmd/finch_unpause.md +++ b/docs/cmd/finch_unpause.md @@ -2,12 +2,12 @@ Unpause all processes within one or more containers -```bash +```text finch unpause [flags] CONTAINER [CONTAINER, ...] ``` ## Options -```bash +```text -h, --help help for unpause ``` diff --git a/docs/cmd/finch_update.md b/docs/cmd/finch_update.md index e8b996ec9..829df1317 100644 --- a/docs/cmd/finch_update.md +++ b/docs/cmd/finch_update.md @@ -2,13 +2,13 @@ Update one or more running containers -```bash +```text finch update [flags] CONTAINER [CONTAINER, ...] ``` ## Options -```bash +```text --blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) --cpu-period uint Limit CPU CFS (Completely Fair Scheduler) period --cpu-quota int Limit CPU CFS (Completely Fair Scheduler) quota (default -1) diff --git a/docs/cmd/finch_version.md b/docs/cmd/finch_version.md index 154242727..9f18cd88f 100644 --- a/docs/cmd/finch_version.md +++ b/docs/cmd/finch_version.md @@ -2,12 +2,12 @@ Shows Finch version information -```bash +```text finch version [flags] ``` ## Options -```bash +```text -h, --help help for version ``` diff --git a/docs/cmd/finch_vm_init.md b/docs/cmd/finch_vm_init.md index d63487076..00e3e5093 100644 --- a/docs/cmd/finch_vm_init.md +++ b/docs/cmd/finch_vm_init.md @@ -2,12 +2,12 @@ Initialize the virtual machine -```bash +```text finch vm init [flags] ``` ## Options -```bash +```text -h, --help help for init ``` diff --git a/docs/cmd/finch_vm_remove.md b/docs/cmd/finch_vm_remove.md index 7c384faba..d027de487 100644 --- a/docs/cmd/finch_vm_remove.md +++ b/docs/cmd/finch_vm_remove.md @@ -2,13 +2,13 @@ Remove the virtual machine instance -```bash +```text finch vm remove [flags] ``` ## Options -```bash +```text -f, --force forcibly remove finch VM -h, --help help for remove ``` diff --git a/docs/cmd/finch_vm_start.md b/docs/cmd/finch_vm_start.md index 1a348c35f..720e24ca1 100644 --- a/docs/cmd/finch_vm_start.md +++ b/docs/cmd/finch_vm_start.md @@ -2,12 +2,12 @@ Start the virtual machine -```bash +```text finch vm start [flags] ``` ## Options -```bash +```text -h, --help help for start ``` diff --git a/docs/cmd/finch_vm_status.md b/docs/cmd/finch_vm_status.md index fcc58586a..ef43aef59 100644 --- a/docs/cmd/finch_vm_status.md +++ b/docs/cmd/finch_vm_status.md @@ -2,12 +2,12 @@ Status of the virtual machine -```bash +```text finch vm status [flags] ``` ## Options -```bash +```text -h, --help help for status ``` diff --git a/docs/cmd/finch_vm_stop.md b/docs/cmd/finch_vm_stop.md index d355c3e00..4ea379834 100644 --- a/docs/cmd/finch_vm_stop.md +++ b/docs/cmd/finch_vm_stop.md @@ -2,13 +2,13 @@ Stop the virtual machine -```bash +```text finch vm stop [flags] ``` ## Options -```bash +```text -f, --force forcibly stop finch VM -h, --help help for stop ``` diff --git a/docs/cmd/finch_volume.md b/docs/cmd/finch_volume.md index 72c50ff1b..bd79abcc4 100644 --- a/docs/cmd/finch_volume.md +++ b/docs/cmd/finch_volume.md @@ -2,13 +2,13 @@ Manage volumes -```bash +```text finch volume [flags] ``` ## Commands -```bash +```text create Create a volume inspect Display detailed information on one or more volumes ls List volumes @@ -18,6 +18,6 @@ finch volume [flags] ## Options -```bash +```text -h, --help help for volume ``` diff --git a/docs/cmd/finch_wait.md b/docs/cmd/finch_wait.md index ed51d42dc..fb5af58a8 100644 --- a/docs/cmd/finch_wait.md +++ b/docs/cmd/finch_wait.md @@ -2,12 +2,12 @@ Block until one or more containers stop, then print their exit codes. -```bash +```text finch wait [flags] CONTAINER [CONTAINER, ...] ``` ## Options -```bash +```text -h, --help help for wait ```