@@ -13,17 +13,16 @@ A network firewall for agentic workflows with domain whitelisting. This tool pro
1313
1414## Get started fast
1515
16- - ** Requirement :** Docker running on your machine
17- - ** Install:**
16+ - ** Prerequisite :** Docker is running
17+ - ** Install:**
1818 ``` bash
1919 curl -sSL https://raw.githubusercontent.com/githubnext/gh-aw-firewall/main/install.sh | sudo bash
2020 ```
21- Review the script before running, or download the latest release binary and verify it with the published ` checksums.txt ` before installing.
22- - ** Run your first command:**
21+ - ** Run your first command:**
2322 ``` bash
2423 sudo awf --allow-domains github.com -- curl https://api.github.com
2524 ```
26- Use the ` -- ` separator to pass the command you want to run behind the firewall.
25+ The ` -- ` separator passes the command you want to run behind the firewall.
2726
2827### GitHub Copilot CLI in one line
2928
@@ -33,47 +32,9 @@ sudo -E awf \
3332 -- copilot --prompt " List my repositories"
3433```
3534
36- ### Installation Options
35+ For checksum verification, version pinning, and manual installation steps, see [ Quick start ] ( docs/quickstart.md ) .
3736
38- ``` bash
39- # Install latest version
40- curl -sSL https://raw.githubusercontent.com/githubnext/gh-aw-firewall/main/install.sh | sudo bash
41-
42- # Install a specific version
43- curl -sSL https://raw.githubusercontent.com/githubnext/gh-aw-firewall/main/install.sh | sudo bash -s -- v1.0.0
44-
45- # Or using environment variable
46- curl -sSL https://raw.githubusercontent.com/githubnext/gh-aw-firewall/main/install.sh | sudo AWF_VERSION=v1.0.0 bash
47- ```
48-
49- This installer automatically:
50- - Downloads the latest release binary (or a specified version)
51- - Verifies SHA256 checksum to detect corruption or tampering
52- - Validates the file is a valid Linux executable
53- - Protects against 404 error pages being saved as binaries
54- - Installs to ` /usr/local/bin/awf `
55-
56- ** Alternative: Manual installation**
57-
58- ``` bash
59- # Download the latest release binary
60- curl -fL https://github.com/githubnext/gh-aw-firewall/releases/latest/download/awf-linux-x64 -o awf
61-
62- # Download checksums for verification
63- curl -fL https://github.com/githubnext/gh-aw-firewall/releases/latest/download/checksums.txt -o checksums.txt
64-
65- # Verify SHA256 checksum
66- sha256sum -c checksums.txt --ignore-missing
67-
68- # Install
69- chmod +x awf
70- sudo mv awf /usr/local/bin/
71-
72- # Verify installation
73- sudo awf --help
74- ```
75-
76- ** Docker Image Verification:** All published container images are cryptographically signed with cosign. See [ docs/image-verification.md] ( docs/image-verification.md ) for verification instructions.
37+ All published container images are cryptographically signed with cosign. See [ docs/image-verification.md] ( docs/image-verification.md ) for verification instructions.
7738
7839## Explore the docs
7940
0 commit comments