Read the Docs with ansible-doc

The ansible-doc command shows full module documentation right in your shell, so you never have to leave the terminal to look things up.

Pass a module name to read its docs: every option, its type, and whether it is required. This is the fastest way to learn a module.

The output lists each option with a description, default value, and choices. This tells you exactly which keys a module accepts.

Add -s to print a ready-to-copy snippet of the module's arguments. It is a perfect starting point for a new task.

Run with -l to list all installed modules with one-line summaries. Pipe it through grep to find what you need.

Not sure of the name? List modules and filter by topic. Searching for service quickly surfaces the relevant modules.

Because ansible-doc reads the modules installed locally, the docs always match your exact version. No risk of stale online pages.

The docs also describe what a module returns, like changed or stdout. That helps when you register results to use later.

Use -t to read docs for other plugin types, not just modules. For example, look up a lookup or filter plugin the same way.

The doc header shows the module's collection and short purpose, so you know its fully qualified name before you write a task.

Before guessing an argument, check ansible-doc first. A ten-second lookup saves a failed run and a confusing error message.

You want a quick copy-paste snippet of a module's arguments, not the full manual.

ansible-doc brings version-matched docs to your terminal: look up a module, use -s for a snippet, and -l to list and search. 📚