1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2024-12-15 17:51:20 +00:00
kyverno/docs/user/cli/commands/kyverno_docs.md

58 lines
2.5 KiB
Markdown
Raw Normal View History

## kyverno docs
Generates reference documentation.
### Synopsis
Generates reference documentation.
The docs command generates Kyverno CLI reference documentation.
It can be used to generate simple markdown files or markdown to be used for the website.
```
kyverno docs [flags]
```
### Examples
```
# Generate simple markdown documentation
KYVERNO_EXPERIMENTAL=true kyverno docs -o . --autogenTag=false
# Generate website documentation
KYVERNO_EXPERIMENTAL=true kyverno docs -o . --website
```
### Options
```
--autogenTag Determines if the generated docs should contain a timestamp (default true)
-h, --help help for docs
-o, --output string Output path (default ".")
--website Website version
```
### Options inherited from parent commands
```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files (no effect when -logtostderr=true)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory (no effect when -logtostderr=true)
--log_file string If non-empty, use this log file (no effect when -logtostderr=true)
--log_file_max_size uint Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
--logtostderr log to standard error instead of files (default true)
--one_output If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
--skip_headers If true, avoid header prefixes in the log messages
--skip_log_headers If true, avoid headers when opening log files (no effect when -logtostderr=true)
--stderrthreshold severity logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true) (default 2)
-v, --v Level number for the log level verbosity
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kyverno](kyverno.md) - Kubernetes Native Policy Management.