Skip to content

docs: condense get started fast section #504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mossaka merged 4 commits into from
Feb 4, 2026
+6 −10
Merged

docs: condense get started fast section #504

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
380e357
Initial plan
Copilot Feb 4, 2026
05b5ba9
docs: shorten get started fast section
Copilot Feb 4, 2026
5b0fd21
docs: add usage to get started fast
Copilot Feb 4, 2026
e0baa51
Merge remote-tracking branch 'origin/main' into copilot/unbloat-readm…
Mossaka Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,12 @@ See [Compatibility](docs/compatibility.md) for full details on supported version

## Get started fast

- **Prerequisite:** Docker is running
- **Install:**
```bash
curl -sSL https://raw.githubusercontent.com/github/gh-aw-firewall/main/install.sh | sudo bash
```
- **Run your first command:**
```bash
sudo awf --allow-domains github.com -- curl https://api.github.com
```
The `--` separator passes the command you want to run behind the firewall.
```bash
curl -sSL https://raw.githubusercontent.com/github/gh-aw-firewall/main/install.sh | sudo bash
sudo awf --allow-domains github.com -- curl https://api.github.com
```

The `--` separator divides firewall options from the command to run.

### GitHub Copilot CLI in one line

Expand Down
Loading