Edit this page on GitHub
Show documentation for components
waypoint docs [options]
Output documentation about the plugins. By default, it lists the documentation for the plugins configured by this project.
The flags can change which plugins are listed and in which format.
-plain- Plain output: no colors, no animation. The default is false.
-a) - App to target. Certain commands require a single app target for Waypoint configurations with multiple apps. If you have a single app, then this can be ignored.
-p) - Project to target.
-w) - Workspace to operate in.
-label=<key=value>- Labels to set for this operation. Can be specified multiple times.
-local- True to use a local runner to execute the operation, false to use a remote runner. If unset, Waypoint will automatically determine where the operation will occur, defaulting to remote if possible.
-remote-source=<key=value>- Override configurations for how remote runners source data. This is specified to the data source type being used in your configuration. This is used for example to set a specific Git ref to run against.
-var=<key=value>- Variable value to set for this operation. Can be specified multiple times.
-var-file=<string>- HCL or JSON file containing variable values to set for this operation. If any ".auto.wpvars" or ".auto.wpvars.json" files are present, they will be automatically loaded.
-builtin- Show documentation on all builtin plugins. The default is false.
-markdown- Show documentation in markdown format. The default is false.
-json- Generate documentation in json format. The default is false.
-type=<string>- Only show documentation for this type of plugin.
-plugin=<string>- Only show documentation for plugins with this name.