Skip to content
Back to search

automated-security-helper

ASH is an extensible, open source SAST, SCA, and IaC security scanner orchestration engine.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/awslabs/automated-security-helper with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/awslabs/automated-security-helper'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/aws-samples--automated-security-helper/badge.svg)](/listings/aws-samples--automated-security-helper)

HTML

<a href="/listings/aws-samples--automated-security-helper"><img src="/api/listings/aws-samples--automated-security-helper/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

These steps run a script from the network that findsafeskills does not scan.

Quick Install (Recommended)

# Install uv on Linux/macOS if it isn't installed already
curl -sSfL https://astral.sh/uv/install.sh | sh

# Create an alias for ASH
alias ash="uvx git+https://github.com/awslabs/automated-security-helper.git@v3.7.0"
# Install uv on Windows with PowerShell if it isn't installed already
irm https://astral.sh/uv/install.ps1 | iex

# Create a function for ASH
function ash { uvx git+https://github.com/awslabs/automated-security-helper.git@v3.7.0 $args }

> **Floating tag `v3`**: We also maintain a `v3` floating tag that always points to the latest stable v3.x release. You can use `@v3` instead of `@v3.7.0` to stay up to date automatically. Pin a specific version (e.g., `@v3.7.0`) when you need reproducible builds.

Other Installation Methods

<details> <summary>Click to expand other installation options</summary>

Using Homebrew (macOS/Linux)

brew tap awslabs/automated-security-helper https://github.com/awslabs/automated-security-helper.git
brew install ash

Using `pipx`

# Install with pipx (isolated environment)
pipx install git+https://github.com/awslabs/automated-security-helper.git@v3.7.0

# Use as normal
ash --help

Using `pip`

pip install git+https://github.com/awslabs/automated-security-helper.git@v3.7.0

Clone the Repository

git clone https://github.com/awslabs/automated-security-helper.git --branch v3.7.0
cd automated-security-helper
pip install .

</details>

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 343 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <a id="overview"></a>
  2. # Automated Security Helper (ASH)
  3. Automated Security Helper, the agentic security harness: open-source orchestration for code, infrastructure, secret, and dependency scanners.
  4. [![Unified CI](https://github.com/awslabs/automated-security-helper/actions/workflows/ash-unified-ci.yml/badge.svg)](https://github.com/awslabs/automated-security-helper/actions/workflows/ash-unified-ci.yml)
  5. [![Install methods](https://github.com/awslabs/automated-security-helper/actions/workflows/ash-install-methods.yml/badge.svg)](https://github.com/awslabs/automated-security-helper/actions/workflows/ash-install-methods.yml)
  6. [Quick start](#quick-start) · [Reports](#reports) · [Integrations](#integrations) · [Configuration](#configuration) · [Documentation](https://awslabs.github.io/automated-security-helper/)
  7. <a id="installation-options"></a>
  8. <a id="basic-usage"></a>
  9. <a id="prerequisites"></a>
  10. <a id="your-first-scan"></a>
  11. ## Quick start
  12. Use Python 3.10 to 3.14 and [pipx](https://pipx.pypa.io/).
  13. For container mode, also install an OCI-compatible runtime such as Docker,
  14. Finch, or Podman.
  15. <!-- doctest: illustrative reason="installs ASH from GitHub over the network and starts a container scan" -->
  16. ```bash
  17. pipx install git+https://github.com/awslabs/automated-security-helper.git@v3.8.0
  18. # Run from the project you want to scan
  19. ash --mode container
  20. ```
  21. The first container run builds the image and prepares scanner dependencies.
  22. Open `.ash/ash_output/reports/ash.html` or run `ash inspect findings`.
  23. ### Execution modes
  24. | Mode | Command | Requirements |
  25. | --- | --- | --- |
  26. | Container | `ash --mode container` | OCI-compatible runtime |
  27. | Local | `ash --mode local` | Local scanner dependencies |
  28. | Pre-commit | `ash --mode precommit` | Python-based scanners with simplified output |
  29. Local and pre-commit workflows use [uv](https://docs.astral.sh/uv/getting-started/installation/)
  30. for managed tool installation. The [installation guide](docs/content/how-to/install.md)
  31. covers platform prerequisites and dependency setup.
  32. <details>
  33. <summary>Other installation methods</summary>
  34. Run with uv:
  35. <!-- doctest: illustrative reason="runs ASH from GitHub over the network" -->
  36. ```bash
  37. uvx --from git+https://github.com/awslabs/automated-security-helper.git@v3.8.0 ash --help
  38. uvx --from git+https://github.com/awslabs/automated-security-helper.git@v3.8.0 ash --mode container
  39. ```
  40. Install in a Python environment:
  41. <!-- doctest: illustrative reason="installs ASH from GitHub over the network" -->
  42. ```bash
  43. pip install git+https://github.com/awslabs/automated-security-helper.git@v3.8.0
  44. ```
  45. Install with Homebrew:
  46. <!-- doctest: illustrative reason="installs ASH with Homebrew over the network" -->
  47. ```bash
  48. brew tap awslabs/automated-security-helper https://github.com/awslabs/automated-security-helper.git
  49. brew trust awslabs/automated-security-helper
  50. brew install ash
  51. ```
  52. Homebrew refuses to load a formula by its short name, as in `brew install ash`, from a tap you have not trusted, so the second line trusts this one; on a Homebrew without `brew trust`, skip that line. Naming the formula in full needs no `brew trust`: `brew install awslabs/automated-security-helper/ash` trusts that one formula as it installs it. The formula builds the tagged release on Homebrew's Python 3.12, with ASH's `cdk` extra, and installs the dependency versions locked in that release's `uv.lock`. It downloads them from PyPI during the install, so the install needs network access, and building with `HOMEBREW_FORMULA_BUILD_NETWORK=deny` is not supported. The formula also installs Node.js, which cdk-nag and npm-audit run on. grype, syft, opengrep and cfn-nag are separate programs that the formula does not install: `ash dependencies install` adds grype, syft and opengrep, and cfn-nag needs Ruby (`gem install cfn-nag`). Until they are installed, a default scan reports them MISSING and exits 1. In container mode, a Homebrew install builds its image from the commit the formula built, or, when Homebrew built it from a source tarball with no git metadata, from the release tag of its version, with a warning that this is a guess.
  53. Install from source:
  54. <!-- doctest: illustrative reason="clones this repository and installs it over the network" -->
  55. ```bash
  56. git clone --branch v3.8.0 https://github.com/awslabs/automated-security-helper.git
  57. cd automated-security-helper
  58. pip install .
  59. ```
  60. Pin `@v3.8.0` for a reproducible install. The floating `@v3` tag is frozen at
  61. v3.8.0 and no longer follows releases, so pin a release tag instead. See the
  62. [installation guide](docs/content/how-to/install.md)
  63. for Windows and offline environments.
  64. </details>
  65. <a id="review-the-results"></a>
  66. ## Reports
  67. - Check the outcome and scanner coverage.
  68. - Review findings by severity.
  69. - Inspect rule IDs, locations, and evidence.
  70. <picture>
  71. <source media="(prefers-color-scheme: dark)" srcset="docs/assets/readme/report-dark.png">
  72. <source media="(prefers-color-scheme: light)" srcset="docs/assets/readme/report-light.png">
  73. <img alt="ASH offline report with the scan outcome, finding counts, and explicit coverage notices." src="docs/assets/readme/report-light.png" width="1200">
  74. </picture>
  75. Example scan results.
  76. Offline HTML reports include search, filters, finding details, and printing.
  77. <!-- doctest: illustrative reason="opens an interactive explorer on the results of an earlier scan" -->
  78. ```bash
  79. ash inspect findings # Open the terminal findings explorer
  80. ash report # Read the text summary of the latest scan
  81. ```
  82. <details>
  83. <summary>Terminal findings explorer</summary>
  84. ![ASH terminal explorer with severity-first findings, scanner and suppression filters, selected finding context, and keyboard shortcuts.](docs/assets/readme/findings-terminal.png)
  85. Use the footer shortcuts to search, filter, inspect, and suppress.
  86. </details>
  87. <a id="output-files"></a>
  88. ### Output files
  89. Default output lives in `.ash/ash_output/`. Enabled reporters write into `reports/`.
  90. | Artifact | Use it for |
  91. | --- | --- |
  92. | `reports/ash.html` | Offline review, filtering, and printing |
  93. | `reports/ash.summary.md` | Pull request comments and Actions summaries |
  94. | `reports/ash.summary.txt` | A readable summary in a file or terminal |
  95. | `reports/ash.sarif` | IDE annotations and SARIF consumers |
  96. | `reports/ash.flat.json` | Scripts and dashboards |
  97. | `reports/ash.csv` | Spreadsheet analysis |
  98. | `ash_aggregated_results.json` | The complete scan record and validation data |
  99. ASH also supports JUnit XML, CycloneDX, SPDX, OCSF, GitLab, YAML, and AWS
  100. reporting destinations. See the [complete format guide](docs/content/reference/output-files.md).
  101. Exit status: `0` means no actionable findings, or findings are allowed by
  102. policy; `1` means execution needs attention; `2` means actionable findings with
  103. failure-on-findings enabled; `3` means a configuration ASH cannot use or an
  104. input it refuses; `4` means a workspace definition or policy error; `5` means a
  105. usage error. A scan with incomplete coverage needs follow-up.
  106. Filters change the view; configured thresholds determine the scan gate.
  107. <a id="bring-ash-into-your-workflow"></a>
  108. ## Integrations
  109. | Your workflow | Next step |
  110. | --- | --- |
  111. | CI and pull requests | [Run ASH in CI](docs/content/getting-started/ci.md) |
  112. | Before a commit | [Set up pre-commit](docs/content/how-to/pre-commit.md) |
  113. | AI coding assistant | [Install an editor or agent integration](ash-agent-plugins/README.md) |
  114. | MCP client | [Connect a client](docs/content/getting-started/agents.md) |
  115. | Multiple projects | [Scan a workspace over MCP](docs/content/how-to/scale-large-repos.md) |
  116. | AWS reporting | [Choose an AWS destination](docs/content/plugins/aws.md) |
  117. | A custom scanner or report | [Build an ASH plugin](docs/content/plugins/index.md) |
  118. See [integration options](docs/content/integrations.md).
  119. <a id="ai-integration-with-mcp"></a>
  120. <a id="installing-ash-into-an-ai-coding-agent"></a>
  121. <a id="client-configuration"></a>
  122. ### Connect an AI assistant
  123. After installing ASH, add this server to your MCP client's configuration:
  124. <!-- doctest: config kind=mcp-client -->
  125. ```json
  126. {
  127. "mcpServers": {
  128. "ash": {
  129. "command": "ash",
  130. "args": ["mcp"]
  131. }
  132. }
  133. }
  134. ```
  135. Stop polling on `completed`, `incomplete`, `failed`, or `cancelled`.
  136. Check scanner coverage before reviewing findings.
  137. For agent instructions, install the `ash-mcp` skill:
  138. <!-- doctest: illustrative reason="installs an agent skill over the network" -->
  139. ```bash
  140. npx skills add awslabs/automated-security-helper
  141. ```
  142. The skill supplies workflow guidance. Configure the MCP server as above, or use
  143. a [platform integration](ash-agent-plugins/README.md) that includes server wiring.
  144. The [MCP server guide](docs/content/how-to/mcp-server.md) covers client-specific
  145. setup. The [HTTP transport guide](docs/content/how-to/mcp-server.md) covers
  146. remote source delivery, session handling, and deployment configuration.
  147. <details>
  148. <summary>MCP tools</summary>
  149. | Tool | Action |
  150. | --- | --- |
  151. | `get_scan_progress` | Read scan status and partial results |
  152. | `get_scan_results` | Read results after a completed or incomplete scan |
  153. | `list_active_scans` | List this session's active and recent scans |
  154. | `cancel_scan` | Cancel a running scan this session started |
  155. | `check_installation` | Check ASH and scanner dependencies |
  156. | `run_ash_scan` | Run a synchronous scan |
  157. | `get_scan_summary` | Read counts, severity, and scan status |
  158. | `get_scan_result_paths` | Locate generated report files |
  159. | `explain_finding` | Look up one finding by ID |
  160. | `get_config` | Read the resolved configuration |
  161. | `diff_scan_results` | Compare two aggregated result files |
  162. | `suggest_suppression` | Draft a suppression for review |
  163. | `resolve_ash_workspace` | Preview a workspace scan plan |
  164. | `run_ash_workspace_scan` | Scan workspace projects with their configurations |
  165. | `list_scanners` | List the built-in and community scanners ASH ships, with metadata |
  166. | `validate_config` | Check a configuration against the schema |
  167. | `list_profiles` | List registered configuration profiles |
  168. | `select_profile` | Apply a profile to the session |
  169. | `set_source_git` | Clone a repository from a host the operator allowed as the scan target |
  170. | `set_source_zip_chunk` | Upload a source archive chunk, up to 1 MiB |
  171. | `set_source_zip_finalize` | Verify and extract the uploaded archive |
  172. | `clear_source` | Delete the delivered source tree |
  173. See the [tool reference](docs/content/reference/mcp-tools.md) for complete
  174. inputs and outputs. Source-delivery tools use the session the server issued on a
  175. network connection, never a client-chosen header; a stateless server issues no
  176. session unless started with `--trust-upstream-session-id`. A local stdio client
  177. can name local paths directly.
  178. </details>
  179. ### Add a pre-commit check
  180. Add to `.pre-commit-config.yaml`:
  181. <!-- doctest: config kind=pre-commit -->
  182. ```yaml
  183. repos:
  184. - repo: https://github.com/awslabs/automated-security-helper
  185. rev: v3.8.0
  186. hooks:
  187. - id: ash
  188. ```
  189. Run `pre-commit run ash --all-files` to check the project.
  190. The `ash` hook runs precommit mode (bandit, detect-secrets, checkov, cdk-nag and npm-audit) and installs the `cdk` extra into its environment. It needs pre-commit running on Python 3.10 to 3.14, and Node.js and npm on `PATH` for cdk-nag and npm-audit. `ash-simple-scan` is the same hook under its earlier id, and `ash-full-scan` scans in the ASH container image instead. See [Run ASH with pre-commit](docs/content/how-to/pre-commit.md) for running without Node.js and for the container hook.
  191. <a id="configuration"></a>
  192. <a id="make-it-fit-your-project"></a>
  193. ## Configuration
  194. Create `.ashrc.yaml` at the project root to name the project, set the severity
  195. gate, and choose scanner and reporter options (existing configs under the older
  196. `.ash/.ash.yaml` name keep loading). The schema provides editor validation.
  197. ```yaml
  198. # yaml-language-server: $schema=https://raw.githubusercontent.com/awslabs/automated-security-helper/refs/heads/main/automated_security_helper/schemas/AshConfig.json
  199. project_name: my-project
  200. global_settings:
  201. severity_threshold: MEDIUM
  202. scanners:
  203. bandit:
  204. enabled: true
  205. options:
  206. confidence_level: high
  207. reporters:
  208. markdown:
  209. enabled: true
  210. options:
  211. include_detailed_findings: true
  212. ```
  213. Use the [configuration guide](docs/content/how-to/configure.md) for
  214. settings and overrides, the [suppression guide](docs/content/how-to/suppress-findings.md)
  215. for an accepted finding with a recorded reason, and [plugin development](docs/content/plugins/index.md)
  216. for new capabilities.
  217. <a id="built-in-scanners"></a>
  218. <details>
  219. <summary>Scanner coverage and local setup</summary>
  220. | Scanner | Coverage | Local setup |
  221. | --- | --- | --- |
  222. | [Bandit](https://github.com/PyCQA/bandit) | Python code | Managed through uv tool isolation |
  223. | [Semgrep](https://github.com/semgrep/semgrep) | Application code across multiple languages | Managed through uv tool isolation |
  224. | [Opengrep](https://github.com/opengrep/opengrep) | Application code with Semgrep-compatible rules | Managed through uv tool isolation |
  225. | [detect-secrets](https://github.com/Yelp/detect-secrets) | Secrets in text files | Included with ASH |
  226. | [Checkov](https://github.com/bridgecrewio/checkov) | Infrastructure and configuration | Managed through uv tool isolation |
  227. | [cfn-nag](https://github.com/stelligent/cfn_nag) | CloudFormation | Ruby and cfn-nag |
  228. | [cdk-nag](https://github.com/cdklabs/cdk-nag) | CloudFormation | ASH's `cdk` extra, and Node.js |
  229. | [npm-audit](https://docs.npmjs.com/cli/commands/npm-audit) | Node.js dependencies | Node.js and npm |
  230. | [Grype](https://github.com/anchore/grype) | Dependency vulnerabilities | Grype |
  231. | [Syft](https://github.com/anchore/syft) | Software bill of materials | Syft |
  232. | [gitleaks](https://github.com/gitleaks/gitleaks) | Secrets in text files | `ash dependencies install` (pinned release binary) |
  233. | [cfn-lint](https://github.com/aws-cloudformation/cfn-lint) | CloudFormation | Managed through uv tool isolation |
  234. | [cfn-guard](https://github.com/aws-cloudformation/cloudformation-guard) | CloudFormation (AWS Guard Rules Registry rules) | `ash dependencies install` (pinned binary and rules) |
  235. | [Trivy](https://github.com/aquasecurity/trivy) (`trivy fs`) | Dependency vulnerabilities | `ash dependencies install` (pinned release binary) |
  236. | [actionlint](https://github.com/rhysd/actionlint) | GitHub Actions workflows | `ash dependencies install` (pinned release binary) |
  237. | [zizmor](https://github.com/zizmorcore/zizmor) | GitHub Actions workflows and composite actions | Managed through uv tool isolation |
  238. Enabled scanners depend on your execution mode and configuration. Check the
  239. [scanner catalog](docs/content/reference/scanners.md) for capabilities
  240. and the [language guide](docs/content/reference/coverage.md) for coverage.
  241. </details>
  242. <a id="faq"></a>
  243. <a id="documentation"></a>
  244. <a id="feedback-and-contributing"></a>
  245. ## Documentation
  246. | Task | Reference |
  247. | --- | --- |
  248. | Understand a command | [CLI reference](docs/content/reference/cli.md) |
  249. | Recover from a setup or scan issue | [Troubleshooting](docs/content/how-to/troubleshoot.md) |
  250. | Understand scanner coverage | [Languages and frameworks](docs/content/reference/coverage.md) |
  251. | Read common answers | [FAQ](docs/content/faq.md) |
  252. | Contribute a change | [Contributing](CONTRIBUTING.md) and [development setup](DEVELOPMENT.md) |
  253. | Review the interfaces | [Design system](docs/content/developer-guide/interface-design.md) and [all-surface review](docs/content/developer-guide/high-end-design-review.md) |
  254. <a id="security"></a>
  255. Report bugs and feature requests through [GitHub issues](https://github.com/awslabs/automated-security-helper/issues).
  256. For security concerns, follow [Security issue notifications](CONTRIBUTING.md#security-issue-notifications).
  257. <a id="license"></a>
  258. Licensed under [Apache 2.0](LICENSE). Bundled fonts and icons retain their
  259. respective licenses alongside their assets.
  260. Build with <3 at Amazon Web Services

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.