Skip to main content
Examples/Toolchain
EXAMPLE

Toolchain

Define the tool versions your stacks and infrastructure depend on — registries, aliases, and pinned versions that Atmos installs on demand.

DX
Try it out View on GitHub
cloudposse / atmos

Try it out

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

atmos init examples/toolchain
cd toolchain

Follow the README for prerequisites and next steps.

Initialization and repository settings

See it in action

RECORDED DEMO
toolchain
Recorded from this example
Real commands. Real output.
README.md1.9 KB
View on GitHub

Example: Toolchain

Configure tool registries and use toolchain-managed tools in custom commands and workflows.

Learn more about Toolchain Configuration.

What You'll See

  • Inline registry defining custom tool downloads alongside the official Aqua registry as fallback
  • Aliases mapping short names (jq) to full specs (jqlang/jq)
  • Custom commands using four dependency patterns: implicit, pinned, constrained, and multi-tool
  • Workflows demonstrating the same four patterns

Try It

cd examples/toolchain

# Install tools from .tool-versions
atmos toolchain install

# Run custom command demos
atmos demo which         # Implicit deps from .tool-versions
atmos demo pinned        # Exact version pinning
atmos demo constrained   # SemVer constraints
atmos demo convert       # Multi-tool pipeline

# Run workflow demos
atmos workflow which -f toolchain-demo
atmos workflow convert -f toolchain-demo

Key Files

FilePurpose
atmos.yamlInline registry + Aqua fallback, aliases, custom commands
.tool-versionsProject tool defaults (jq 1.7.1, yq 4.45.1)
workflows/toolchain-demo.yamlWorkflow versions of the same 4 patterns