Merge pull request #22 from eunomie/docs-help

eunomie · web-flow · commit a22f536465d5 · 2024-10-17T18:25:34.000+02:00
Use -h/--help instead of -d/--docs to print help
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ $ docker runx decorate alpine --tag NAMESPACE/REPOSITORY
 You can then display the embedded readme:
 
 ```
-$ dockedr runx NAMESPACE/REPOSITORY --docs
+$ docker runx NAMESPACE/REPOSITORY --help
 ```
 
 Or run the `hello` action:
@@ -69,7 +69,7 @@ See more examples in the [examples](/examples) directory.
 
 ### Usage
 
-> `docker runx IMAGE --docs`
+> `docker runx IMAGE --help`
 >
 > Display the embedded documentation of an image and print the list of available actions.
 
@@ -81,7 +81,7 @@ See more examples in the [examples](/examples) directory.
 >
 > Run a specific action on an image.
 
-> `docker runx IMAGE ACTION --docs`
+> `docker runx IMAGE ACTION --help`
 >
 > Display a detailed documentation of a specific action. This will also display the list of available options, shell scripts, environment variables.
 
diff --git a/docs/index.markdown b/docs/index.markdown
@@ -47,7 +47,7 @@ $ docker runx decorate alpine --tag NAMESPACE/REPOSITORY
 You can then display the embedded readme:
 
 ```
-$ dockedr runx NAMESPACE/REPOSITORY --docs
+$ docker runx NAMESPACE/REPOSITORY --help
 ```
 
 Or run the `hello` action:
@@ -62,7 +62,7 @@ See more examples in the [examples](https://github.com/eunomie/docker-runx/tree/
 
 ### Usage
 
-> `docker runx IMAGE --docs`
+> `docker runx IMAGE --help`
 >
 > Display the embedded documentation of an image and print the list of available actions.
 
@@ -74,7 +74,7 @@ See more examples in the [examples](https://github.com/eunomie/docker-runx/tree/
 >
 > Run a specific action on an image.
 
-> `docker runx IMAGE ACTION --docs`
+> `docker runx IMAGE ACTION --help`
 >
 > Display a detailed documentation of a specific action. This will also display the list of available options, shell scripts, environment variables.
 
diff --git a/docs/reference/docker_runx.yaml b/docs/reference/docker_runx.yaml
@@ -7,12 +7,10 @@ plink: docker.yaml
 cname:
     - docker runx cache
     - docker runx decorate
-    - docker runx help
     - docker runx version
 clink:
     - docker_runx_cache.yaml
     - docker_runx_decorate.yaml
-    - docker_runx_help.yaml
     - docker_runx_version.yaml
 options:
     - option: ask
@@ -30,6 +28,17 @@ options:
       value_type: bool
       default_value: "false"
       description: Print the documentation of the image
+      deprecated: true
+      hidden: true
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: help
+      shorthand: h
+      value_type: bool
+      default_value: "false"
+      description: Print usage or runx image/action documentation
       deprecated: false
       hidden: false
       experimental: false
diff --git a/docs/reference/docker_runx_cache.yaml b/docs/reference/docker_runx_cache.yaml
@@ -9,6 +9,18 @@ cname:
 clink:
     - docker_runx_cache_df.yaml
     - docker_runx_cache_prune.yaml
+inherited_options:
+    - option: help
+      shorthand: h
+      value_type: bool
+      default_value: "false"
+      description: Print usage or runx image/action documentation
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 hidden: false
 experimental: false
diff --git a/docs/reference/docker_runx_cache_df.yaml b/docs/reference/docker_runx_cache_df.yaml
@@ -4,6 +4,18 @@ long: Show disk usage
 usage: docker runx cache df
 pname: docker runx cache
 plink: docker_runx_cache.yaml
+inherited_options:
+    - option: help
+      shorthand: h
+      value_type: bool
+      default_value: "false"
+      description: Print usage or runx image/action documentation
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 hidden: false
 experimental: false
diff --git a/docs/reference/docker_runx_cache_prune.yaml b/docs/reference/docker_runx_cache_prune.yaml
@@ -28,6 +28,18 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+inherited_options:
+    - option: help
+      shorthand: h
+      value_type: bool
+      default_value: "false"
+      description: Print usage or runx image/action documentation
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 hidden: false
 experimental: false
diff --git a/docs/reference/docker_runx_decorate.yaml b/docs/reference/docker_runx_decorate.yaml
@@ -55,6 +55,18 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+inherited_options:
+    - option: help
+      shorthand: h
+      value_type: bool
+      default_value: "false"
+      description: Print usage or runx image/action documentation
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 hidden: false
 experimental: false
diff --git a/docs/reference/docker_runx_version.yaml b/docs/reference/docker_runx_version.yaml
@@ -4,6 +4,18 @@ long: Show Docker RunX version information
 usage: docker runx version
 pname: docker runx
 plink: docker_runx.yaml
+inherited_options:
+    - option: help
+      shorthand: h
+      value_type: bool
+      default_value: "false"
+      description: Print usage or runx image/action documentation
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 hidden: false
 experimental: false
diff --git a/docs/reference/runx.md b/docs/reference/runx.md
@@ -5,20 +5,19 @@ Docker Run, better
 
 ### Subcommands
 
-| Name                           | Description                                      |
-|:-------------------------------|:-------------------------------------------------|
-| [`cache`](runx_cache.md)       | Manage Docker RunX cache and temporary files     |
-| [`decorate`](runx_decorate.md) | Decorate an image by attaching a runx manifest   |
-| [`help`](runx_help.md)         | Display information about the available commands |
-| [`version`](runx_version.md)   | Show Docker RunX version information             |
+| Name                           | Description                                    |
+|:-------------------------------|:-----------------------------------------------|
+| [`cache`](runx_cache.md)       | Manage Docker RunX cache and temporary files   |
+| [`decorate`](runx_decorate.md) | Decorate an image by attaching a runx manifest |
+| [`version`](runx_version.md)   | Show Docker RunX version information           |
 
 
 ### Options
 
 | Name           | Type          | Default | Description                                                       |
 |:---------------|:--------------|:--------|:------------------------------------------------------------------|
 | `--ask`        | `bool`        |         | Do not read local configuration option values and always ask them |
-| `-d`, `--docs` | `bool`        |         | Print the documentation of the image                              |
+| `-h`, `--help` | `bool`        |         | Print usage or runx image/action documentation                    |
 | `-l`, `--list` | `bool`        |         | List available actions                                            |
 | `--opt`        | `stringArray` |         | Set an option value                                               |
 | `-y`, `--yes`  | `bool`        |         | Do not check flags before running the command                     |
diff --git a/docs/reference/runx_cache.md b/docs/reference/runx_cache.md
@@ -11,6 +11,12 @@ Manage Docker RunX cache and temporary files
 | [`prune`](runx_cache_prune.md) | Remove cache entries not accessed recently |
 
 
+### Options
+
+| Name           | Type   | Default | Description                                    |
+|:---------------|:-------|:--------|:-----------------------------------------------|
+| `-h`, `--help` | `bool` |         | Print usage or runx image/action documentation |
+
 
 <!---MARKER_GEN_END-->
 
diff --git a/docs/reference/runx_cache_df.md b/docs/reference/runx_cache_df.md
@@ -3,6 +3,12 @@
 <!---MARKER_GEN_START-->
 Show disk usage
 
+### Options
+
+| Name           | Type   | Default | Description                                    |
+|:---------------|:-------|:--------|:-----------------------------------------------|
+| `-h`, `--help` | `bool` |         | Print usage or runx image/action documentation |
+
 
 <!---MARKER_GEN_END-->
 
diff --git a/docs/reference/runx_cache_prune.md b/docs/reference/runx_cache_prune.md
@@ -5,10 +5,11 @@ By default remove cache entries not accessed in the last 30 days. Use --all/-a t
 
 ### Options
 
-| Name            | Type   | Default | Description                    |
-|:----------------|:-------|:--------|:-------------------------------|
-| `-a`, `--all`   | `bool` |         | Remove all cache entries       |
-| `-f`, `--force` | `bool` |         | Do not prompt for confirmation |
+| Name            | Type   | Default | Description                                    |
+|:----------------|:-------|:--------|:-----------------------------------------------|
+| `-a`, `--all`   | `bool` |         | Remove all cache entries                       |
+| `-f`, `--force` | `bool` |         | Do not prompt for confirmation                 |
+| `-h`, `--help`  | `bool` |         | Print usage or runx image/action documentation |
 
 
 <!---MARKER_GEN_END-->
diff --git a/docs/reference/runx_decorate.md b/docs/reference/runx_decorate.md
@@ -7,6 +7,7 @@ Decorate an image by attaching a runx manifest
 
 | Name            | Type     | Default     | Description                                     |
 |:----------------|:---------|:------------|:------------------------------------------------|
+| `-h`, `--help`  | `bool`   |             | Print usage or runx image/action documentation  |
 | `--no-config`   | `bool`   |             | Do not attach a runx configuration to the image |
 | `--no-readme`   | `bool`   |             | Do not attach a README to the image             |
 | `-t`, `--tag`   | `string` |             | Tag to push the decorated image to              |
diff --git a/docs/reference/runx_version.md b/docs/reference/runx_version.md
@@ -3,6 +3,12 @@
 <!---MARKER_GEN_START-->
 Show Docker RunX version information
 
+### Options
+
+| Name           | Type   | Default | Description                                    |
+|:---------------|:-------|:--------|:-----------------------------------------------|
+| `-h`, `--help` | `bool` |         | Print usage or runx image/action documentation |
+
 
 <!---MARKER_GEN_END-->
 
diff --git a/internal/commands/help/help.go b/internal/commands/help/help.go
diff --git a/internal/commands/root/root.go b/internal/commands/root/root.go
diff --git a/internal/runx/md.go b/internal/runx/md.go
diff --git a/internal/runx/run.go b/internal/runx/run.go
diff --git a/internal/runx/runx.go b/internal/runx/runx.go

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ $ docker runx decorate alpine --tag NAMESPACE/REPOSITORY`
`54`	`54`	`You can then display the embedded readme:`
`55`	`55`
`56`	`56`	```
`57`		`-$ dockedr runx NAMESPACE/REPOSITORY --docs`
	`57`	`+$ docker runx NAMESPACE/REPOSITORY --help`
`58`	`58`	```
`59`	`59`
`60`	`60`	Or run the `hello` action:
`@@ -69,7 +69,7 @@ See more examples in the [examples](/examples) directory.`
`69`	`69`
`70`	`70`	`### Usage`
`71`	`71`
`72`		-> `docker runx IMAGE --docs`
	`72`	+> `docker runx IMAGE --help`
`73`	`73`	`>`
`74`	`74`	`> Display the embedded documentation of an image and print the list of available actions.`
`75`	`75`
`@@ -81,7 +81,7 @@ See more examples in the [examples](/examples) directory.`
`81`	`81`	`>`
`82`	`82`	`> Run a specific action on an image.`
`83`	`83`
`84`		-> `docker runx IMAGE ACTION --docs`
	`84`	+> `docker runx IMAGE ACTION --help`
`85`	`85`	`>`
`86`	`86`	`> Display a detailed documentation of a specific action. This will also display the list of available options, shell scripts, environment variables.`
`87`	`87`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ $ docker runx decorate alpine --tag NAMESPACE/REPOSITORY`
`47`	`47`	`You can then display the embedded readme:`
`48`	`48`
`49`	`49`	```
`50`		`-$ dockedr runx NAMESPACE/REPOSITORY --docs`
	`50`	`+$ docker runx NAMESPACE/REPOSITORY --help`
`51`	`51`	```
`52`	`52`
`53`	`53`	Or run the `hello` action:
`@@ -62,7 +62,7 @@ See more examples in the [examples](https://github.com/eunomie/docker-runx/tree/`
`62`	`62`
`63`	`63`	`### Usage`
`64`	`64`
`65`		-> `docker runx IMAGE --docs`
	`65`	+> `docker runx IMAGE --help`
`66`	`66`	`>`
`67`	`67`	`> Display the embedded documentation of an image and print the list of available actions.`
`68`	`68`
`@@ -74,7 +74,7 @@ See more examples in the [examples](https://github.com/eunomie/docker-runx/tree/`
`74`	`74`	`>`
`75`	`75`	`> Run a specific action on an image.`
`76`	`76`
`77`		-> `docker runx IMAGE ACTION --docs`
	`77`	+> `docker runx IMAGE ACTION --help`
`78`	`78`	`>`
`79`	`79`	`> Display a detailed documentation of a specific action. This will also display the list of available options, shell scripts, environment variables.`
`80`	`80`