Waypoint Docs

Command: waypoint docs

Show documentation for components

Usage

Usage: waypoint docs [options]

Global Options

• -plain - Plain output: no colors, no animation.
• -app=<string> - 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.
• -workspace=<string> - Workspace to operate in.

Operation Options

• -label=<key=value> - Labels to set for this operation. Can be specified multiple times.
• -remote - True to use a remote runner to execute. This defaults to false unless 'runner.default' is set in your configuration.
• -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.

Command Options

• -builtin - Show documentation on all builtin plugins
• -markdown - Show documentation in markdown format
• -type=<string> - Only show documentation for this type of plugin
• -plugin=<string> - Only show documentation for plugins with this name