---
layout: commands
page_title: 'Commands: Docs'
sidebar_title: 'docs'
description: 'Show documentation for components'
---

# Waypoint Docs

Command: `waypoint docs`

Show documentation for components

@include "commands/docs_desc.mdx"

## Usage

Usage: `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.

#### Global Options

- `-plain` - Plain output: no colors, no animation.
- `-app=<string>` (`-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.
- `-project=<string>` (`-p`) - Project to target.
- `-workspace=<string>` (`-w`) - Workspace to operate in.

#### Operation Options

- `-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.

#### 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

@include "commands/docs_more.mdx"
