mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 04:48:33 +07:00
@@ -62,7 +62,7 @@ func NewCommand() *cobra.Command {
|
|||||||
cmd.PersistentFlags().StringVarP(&config.File, "config", "c", ".terraform-docs.yml", "config file name")
|
cmd.PersistentFlags().StringVarP(&config.File, "config", "c", ".terraform-docs.yml", "config file name")
|
||||||
cmd.PersistentFlags().BoolVar(&config.Recursive.Enabled, "recursive", false, "update submodules recursively (default false)")
|
cmd.PersistentFlags().BoolVar(&config.Recursive.Enabled, "recursive", false, "update submodules recursively (default false)")
|
||||||
cmd.PersistentFlags().StringVar(&config.Recursive.Path, "recursive-path", "modules", "submodules path to recursively update")
|
cmd.PersistentFlags().StringVar(&config.Recursive.Path, "recursive-path", "modules", "submodules path to recursively update")
|
||||||
cmd.PersistentFlags().BoolVar(&config.Recursive.IncludeMain, "recursive-include-main", true, "include the main module (default true)")
|
cmd.PersistentFlags().BoolVar(&config.Recursive.IncludeMain, "recursive-include-main", true, "include the main module")
|
||||||
|
|
||||||
cmd.PersistentFlags().StringSliceVar(&config.Sections.Show, "show", []string{}, "show section ["+print.AllSections+"]")
|
cmd.PersistentFlags().StringSliceVar(&config.Sections.Show, "show", []string{}, "show section ["+print.AllSections+"]")
|
||||||
cmd.PersistentFlags().StringSliceVar(&config.Sections.Hide, "hide", []string{}, "hide section ["+print.AllSections+"]")
|
cmd.PersistentFlags().StringSliceVar(&config.Sections.Hide, "hide", []string{}, "hide section ["+print.AllSections+"]")
|
||||||
|
|||||||
@@ -22,7 +22,9 @@ set.
|
|||||||
Path to find submodules can be configured with `--recursive-path` (defaults to
|
Path to find submodules can be configured with `--recursive-path` (defaults to
|
||||||
`modules`).
|
`modules`).
|
||||||
|
|
||||||
The main module document is generated by default, which can be configured with `--recursive-include-main`. Should the main module document be excluded from document generation, use `--recursive-include-main=false`.
|
The main module document is generated by default, which can be configured with
|
||||||
|
`--recursive-include-main`. Should the main module document be excluded from
|
||||||
|
document generation, use `--recursive-include-main=false`.
|
||||||
|
|
||||||
Each submodule can also have their own `.terraform-docs.yml` config file, to
|
Each submodule can also have their own `.terraform-docs.yml` config file, to
|
||||||
override configuration from root module.
|
override configuration from root module.
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ terraform-docs asciidoc document [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--required show Required column or section (default true)
|
--required show Required column or section (default true)
|
||||||
--sensitive show Sensitive column or section (default true)
|
--sensitive show Sensitive column or section (default true)
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ terraform-docs asciidoc table [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--required show Required column or section (default true)
|
--required show Required column or section (default true)
|
||||||
--sensitive show Sensitive column or section (default true)
|
--sensitive show Sensitive column or section (default true)
|
||||||
|
|||||||
@@ -45,7 +45,7 @@ terraform-docs asciidoc [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
||||||
--sort sort items (default true)
|
--sort sort items (default true)
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ terraform-docs json [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
||||||
--sort sort items (default true)
|
--sort sort items (default true)
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ terraform-docs markdown document [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--required show Required column or section (default true)
|
--required show Required column or section (default true)
|
||||||
--sensitive show Sensitive column or section (default true)
|
--sensitive show Sensitive column or section (default true)
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ terraform-docs markdown table [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--required show Required column or section (default true)
|
--required show Required column or section (default true)
|
||||||
--sensitive show Sensitive column or section (default true)
|
--sensitive show Sensitive column or section (default true)
|
||||||
|
|||||||
@@ -47,7 +47,7 @@ terraform-docs markdown [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
||||||
--sort sort items (default true)
|
--sort sort items (default true)
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ terraform-docs pretty [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
||||||
--sort sort items (default true)
|
--sort sort items (default true)
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ terraform-docs [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
||||||
--sort sort items (default true)
|
--sort sort items (default true)
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ terraform-docs tfvars hcl [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
||||||
--sort sort items (default true)
|
--sort sort items (default true)
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ terraform-docs tfvars json [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
||||||
--sort sort items (default true)
|
--sort sort items (default true)
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ Generate terraform.tfvars of inputs.
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
||||||
--sort sort items (default true)
|
--sort sort items (default true)
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ terraform-docs toml [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
||||||
--sort sort items (default true)
|
--sort sort items (default true)
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ terraform-docs xml [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
||||||
--sort sort items (default true)
|
--sort sort items (default true)
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ terraform-docs yaml [PATH] [flags]
|
|||||||
--output-values-from string inject output values from file into outputs (default "")
|
--output-values-from string inject output values from file into outputs (default "")
|
||||||
--read-comments use comments as description when description is empty (default true)
|
--read-comments use comments as description when description is empty (default true)
|
||||||
--recursive update submodules recursively (default false)
|
--recursive update submodules recursively (default false)
|
||||||
--recursive-include-main include the main module (default true) (default true)
|
--recursive-include-main include the main module (default true)
|
||||||
--recursive-path string submodules path to recursively update (default "modules")
|
--recursive-path string submodules path to recursively update (default "modules")
|
||||||
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
|
||||||
--sort sort items (default true)
|
--sort sort items (default true)
|
||||||
|
|||||||
Reference in New Issue
Block a user