You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| Local | Python 3.10+, UV package manager, [Git](https://git-scm.com/downloads)| Some scanners require additional tools (see table above) |
82
+
| Local | Python 3.10+, UV package manager| Some scanners require additional tools (see table above) |
83
83
| Container | Any OCI-compatible container runtime ([Finch](https://github.com/runfinch/finch), [Docker](https://docs.docker.com/get-docker/), [Podman](https://podman.io/), etc.) | On Windows: WSL2 is typically required |
84
-
| Precommit | Python 3.10+, UV package manager, [Git](https://git-scm.com/downloads)| Subset of scanners, optimized for speed |
84
+
| Precommit | Python 3.10+, UV package manager| Subset of scanners, optimized for speed |
85
85
86
86
## Installation Options
87
87
@@ -92,25 +92,18 @@ ASH v3 integrates multiple open-source security tools as scanners. Tools like Ba
92
92
curl -sSfL https://astral.sh/uv/install.sh | sh
93
93
94
94
# Create an alias for ASH
95
-
alias ash="uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.4"
95
+
alias ash="uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.5"
96
96
```
97
97
98
98
```powershell
99
-
# Install Git for Windows if not already installed
100
-
winget install --id Git.Git -e --source winget
101
-
102
99
# Install uv on Windows with PowerShell if it isn't installed already
103
100
irm https://astral.sh/uv/install.ps1 | iex
104
101
105
-
# Create a function for ASH (current session)
106
-
function ash { uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.4 $args }
107
-
108
-
# Persist the function for new terminals by adding it to your PowerShell profile
function ash { uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.5 $args }
111
104
```
112
105
113
-
> **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.5.4` to stay up to date automatically. Pin a specific version (e.g., `@v3.5.4`) when you need reproducible builds.
106
+
> **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.5.5` to stay up to date automatically. Pin a specific version (e.g., `@v3.5.5`) when you need reproducible builds.
@@ -399,24 +392,6 @@ The `ash_aggregated_results.json` file includes comprehensive validation informa
399
392
<summary>How do I run ASH on Windows?</summary>
400
393
401
394
ASH v3 can run directly on Windows in local mode with Python 3.10+. Simply install ASH using pip, pipx, or uvx and run with `--mode local`. For container mode, you'll need WSL2 and a container runtime like Docker Desktop, Rancher Desktop, or Podman Desktop.
402
-
403
-
**Prerequisites for Windows:**
404
-
- [Git for Windows](https://git-scm.com/downloads/win) — required for `uvx` and `pip` git-based installs
405
-
- Python 3.10+ and UV (`irm https://astral.sh/uv/install.ps1 | iex`)
406
-
407
-
**Long path errors:** If you see `path too long` or `filename too long` errors during installation, enable Windows long path support:
> **Tip**: The examples below use pinned versions (`@v3.5.4`) for reproducibility. You can also use the `v3` floating tag (`@v3`) to always get the latest stable v3.x release, though pinned versions are recommended for CI/CD.
258
+
> **Tip**: The examples below use pinned versions (`@v3.5.5`) for reproducibility. You can also use the `v3` floating tag (`@v3`) to always get the latest stable v3.x release, though pinned versions are recommended for CI/CD.
Copy file name to clipboardExpand all lines: docs/content/docs/installation-guide.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ ASH v3 uses UV's tool isolation system to automatically manage most scanner depe
33
33
curl -sSf https://astral.sh/uv/install.sh | sh
34
34
35
35
# Create an alias for ASH
36
-
alias ash="uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.4"
36
+
alias ash="uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.5"
37
37
38
38
# Use as normal
39
39
ash --help
@@ -45,22 +45,22 @@ ash --help
45
45
irm https://astral.sh/uv/install.ps1 | iex
46
46
47
47
# Create a function for ASH
48
-
function ash { uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.4 $args }
48
+
function ash { uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.5 $args }
49
49
50
50
# Use as normal
51
51
ash --help
52
52
```
53
53
54
54
!!! tip "Floating tag `v3`"
55
-
We also maintain a `v3` floating tag that always points to the latest stable v3.x release. You can use `@v3` instead of a specific version to stay up to date automatically. Pin a specific version (e.g., `@v3.5.4`) when you need reproducible builds, such as in CI/CD pipelines.
55
+
We also maintain a `v3` floating tag that always points to the latest stable v3.x release. You can use `@v3` instead of a specific version to stay up to date automatically. Pin a specific version (e.g., `@v3.5.5`) when you need reproducible builds, such as in CI/CD pipelines.
56
56
57
57
#### 2. Using `pipx`
58
58
59
59
[`pipx`](https://pypa.github.io/pipx/) installs packages in isolated environments and makes their entry points available globally.
> **Tip**: You can also use the `v3` floating tag (`@v3`) instead of a specific version to always get the latest stable v3.x release. Pin a specific version for CI/CD or reproducible environments.
alias ash="uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.4"
28
+
alias ash="uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.5"
29
29
```
30
30
31
31
#### Windows PowerShell
@@ -34,25 +34,25 @@ alias ash="uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5
34
34
irm https://astral.sh/uv/install.ps1 | iex
35
35
36
36
# Create a function for ASH
37
-
function ash { uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.4 $args }
37
+
function ash { uvx git+https://github.com/awslabs/automated-security-helper.git@v3.5.5 $args }
38
38
```
39
39
40
-
> **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 a specific version to stay up to date automatically. Pin a specific version (e.g., `@v3.5.4`) when you need reproducible builds.
40
+
> **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 a specific version to stay up to date automatically. Pin a specific version (e.g., `@v3.5.5`) when you need reproducible builds.
0 commit comments