Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/aws-samples/sample-well-architected-skills-and-steering/llms.txt

Use this file to discover all available pages before exploring further.

The local install script gives you the most control over how and where skills are installed. Because you have a full clone on disk, you can use --symlink mode to have your project always reflect the latest version of the repo without reinstalling, target multiple tools in a single command, uninstall cleanly, and check for newer releases. The same script (install.sh on macOS/Linux, install.ps1 on Windows) handles all 14 supported tools.

Step 1 — Clone the repository

git clone https://github.com/aws-samples/sample-well-architected-skills-and-steering.git
cd sample-well-architected-skills-and-steering

Step 2 — Run the install script

1

Auto-detect tools in your project

Pass --tool auto to let the installer scan your project directory for AI tool configuration markers and install for every tool it finds.
./install.sh ~/my-project --tool auto
2

Install for a specific tool

Target a single tool by name. See the options reference for all valid tool names.
./install.sh ~/my-project --tool claude-code
3

Install for multiple tools at once

Repeat --tool on bash or pass a comma-separated list on PowerShell to install for several tools in one run.
./install.sh ~/my-project --tool kiro --tool claude-code --tool cursor
4

Install for all supported tools

Use --tool all to install adapters for every supported tool in one pass.
./install.sh ~/my-project --tool all
5

Install globally

Use --global to install to your home directory. Global installs apply to all projects that don’t have their own project-level configuration.
./install.sh --global --tool claude-code
By default the installer copies files into your project. Symlink mode creates symbolic links instead, so every time the cloned repository is updated (via git pull), your project immediately reflects the latest skills and steering without any reinstallation step.
./install.sh ~/my-project --tool claude-code --symlink
On Windows, creating symbolic links requires either Administrator privileges or Developer Mode to be enabled in Settings → For developers. If the installer fails with a permissions error, run your PowerShell session as Administrator or enable Developer Mode and retry.
Symlinks are particularly useful for the wa-review skill, which includes 57 question reference files and 27 lens packs totalling several megabytes. With symlinks, you can git pull the upstream repo to pick up refreshed reference data without manually re-running the installer across all your projects.

Uninstalling

The --uninstall flag removes all Well-Architected files that were previously installed for the specified tool. It mirrors the exact set of files and directories that the installer would write, so it is safe to run even if some files were later moved or deleted manually.
macOS / Linux
# Uninstall for a specific tool
./install.sh ~/my-project --uninstall --tool claude-code

# Uninstall for all tools
./install.sh ~/my-project --uninstall --tool all
The --uninstall flag is only available on install.sh (macOS/Linux). install.ps1 does not include an uninstall option. On Windows, remove the installed files manually by deleting the directories listed in the tool compatibility matrix for your tool.

Checking for updates

Run --check-update from anywhere — no target directory is required. The script queries the GitHub Releases API and compares the latest published version against the version embedded in the script.
./install.sh --check-update
If an update is available, the output shows the version delta and a link to the release. To update, run git pull in your clone and then re-run the installer against your projects.

Build docs developers (and LLMs) love