Skip to main content

atmos docs

Access documentation while you work and generate documentation for your own project. Open Atmos or component documentation from the terminal, or use configured generators to produce READMEs and release notes.

Configure Documentation Generation

Learn how to configure documentation generators for READMEs, release notes, and other artifacts.

Usage​

atmos docs --help
 

When run on its own, the atmos docs command opens Atmos docs, but it can also display documentation for specified components. For example:

atmos docs
atmos docs vpc
atmos docs eks/cluster

Subcommands​