Skip to main content

Try Runnable Examples Directly from the Documentation

· One min read
Erik Osterman
Erik Osterman
Founder @ Cloud Posse

Reading about a feature should lead directly to trying it. Finding its example directory, installing Atmos, and assembling the first commands adds unnecessary work. Changelog posts with runnable examples, command documentation, and individual example pages now include a quick start with installation instructions and copyable commands.

Try it out​

Copy the example into a new directory and make it your own:

atmos init examples/policies
cd policies

Validate the local policy bundle and run its offline fixtures. No Terraform installation or cloud credentials are required:

atmos policy check
atmos policy test tests/cases.json
Explore the example →Initialization and repository settings

How it works​

Each quick start opens on the example tab, with copyable commands to initialize a complete project and try the feature. The Install Atmos tab is there when you need it. Related examples share one installation tab and have their own named tabs.

Policy validation output​

The policy check command now shows a readable summary on stderr. Scripts consuming its previous JSON output must use atmos policy check --format json, which preserves the valid, rules, and hooks fields on stdout.

Get Involved​

Tell us which examples would help you in GitHub Discussions.