Skip to content

Commit cdb0c2a

Browse files
CopilotMossaka
Copilot
and
Mossaka
committed
docs: simplify agent tool lists
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
1 parent 37d5735 commit cdb0c2a

2 files changed

Lines changed: 40 additions & 188 deletions

File tree

‎docs-site/src/content/docs/reference/agent-images.md‎

Lines changed: 20 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -54,35 +54,18 @@ sudo awf --tty --allow-domains '' -- bash
5454

5555
The default `agent` image (based on Ubuntu 22.04) includes the following pre-installed tools:
5656

57-
### Runtimes
58-
59-
| Tool | Version | Path | Notes |
60-
|------|---------|------|-------|
61-
| Node.js | v22.22.0 | `/usr/bin/node` | Includes npm, npx |
62-
| npm | 10.9.4 | `/usr/bin/npm` | — |
63-
| npx | 10.9.4 | `/usr/bin/npx` | — |
64-
| Python | 3.10.12 | `/usr/bin/python3` | No pip installed by default |
65-
66-
### Version Control & CI/CD
67-
68-
| Tool | Version | Notes |
69-
|------|---------|-------|
70-
| git | 2.34.1 | Standard git client |
71-
| GitHub CLI | 2.4.0+dfsg1 | `gh` command for GitHub API |
72-
73-
### Network Tools
74-
7557
| Tool | Version | Package | Notes |
7658
|------|---------|---------|-------|
59+
| Node.js | v22.22.0 | — | Includes npm, npx |
60+
| npm | 10.9.4 | — | — |
61+
| npx | 10.9.4 | — | — |
62+
| Python | 3.10.12 | — | No pip installed by default |
63+
| git | 2.34.1 | `git` | Standard git client |
64+
| GitHub CLI | 2.4.0+dfsg1 | `gh-cli` | `gh` command for GitHub API |
7765
| curl | 7.81.0 | `curl` | HTTP client |
7866
| dig | 9.18.39 | `dnsutils` | DNS lookup utility |
7967
| ifconfig | 2.10-alpha | `net-tools` | Network interface config |
8068
| netcat | 1.218 | `netcat-openbsd` | TCP/UDP connections |
81-
82-
### System Tools
83-
84-
| Tool | Version | Package | Notes |
85-
|------|---------|---------|-------|
8669
| iptables | 1.8.7 | `iptables` | Firewall rules (host-level control) |
8770
| gosu | 1.14 | `gosu` | Run commands as other users |
8871
| capsh | — | `libcap2-bin` | Capability management |
@@ -95,97 +78,39 @@ The `docker` command is present but is a stub—there is no Docker daemon runnin
9578

9679
## Agent-Act Image Tools
9780

98-
The `agent-act` image (based on Ubuntu 24.04) includes all tools from the `agent` image plus additional runtimes and build tools for GitHub Actions compatibility.
99-
100-
### Runtimes
101-
102-
| Tool | Version | Path | Notes |
103-
|------|---------|------|-------|
104-
| Node.js | v18.20.8 | `/opt/hostedtoolcache/node/18.20.8/x64/bin/node` | Default in PATH (from actions/setup-node) |
105-
| npm | 10.8.2 | `/opt/hostedtoolcache/node/18.20.8/x64/bin/npm` | Bundled with Node.js 18 |
106-
| npx | 10.8.2 | `/opt/hostedtoolcache/node/18.20.8/x64/bin/npx` | Bundled with Node.js 18 |
107-
| corepack | 0.32.0 | `/opt/hostedtoolcache/node/18.20.8/x64/bin/corepack` | Yarn/pnpm manager |
108-
| Node.js (system) | v22.22.0 | `/usr/bin/node` | Alternative system installation |
109-
| Python | 3.12.3 | `/usr/bin/python3` | Includes pip 24.0 |
110-
| pip | 24.0 | `/usr/bin/pip3` | Python package manager |
111-
112-
:::tip[Multiple Node.js Versions]
113-
The `agent-act` image has Node.js v18 in PATH by default (from `/opt/hostedtoolcache`) and Node.js v22 available at `/usr/bin/node`. Use `which node` to check which version is active, or specify the full path for a specific version.
114-
:::
115-
116-
### Version Control & CI/CD
117-
118-
| Tool | Version | Notes |
119-
|------|---------|-------|
120-
| git | 2.52.0 | Standard git client |
121-
| GitHub CLI | 2.45.0 | `gh` command for GitHub API |
122-
| git-lfs | 3.7.1 | Git Large File Storage |
123-
124-
### Build Tools
81+
The `agent-act` image (based on Ubuntu 24.04) includes the following pre-installed tools:
12582

12683
| Tool | Version | Package | Notes |
12784
|------|---------|---------|-------|
85+
| Node.js | v18.20.8 | — | Default in PATH (from `/opt/hostedtoolcache`) |
86+
| npm | 10.8.2 | — | Bundled with Node.js 18 |
87+
| npx | 10.8.2 | — | Bundled with Node.js 18 |
88+
| corepack | 0.32.0 | — | Yarn/pnpm manager |
89+
| Node.js (system) | v22.22.0 | — | Alternative system installation at `/usr/bin/node` |
90+
| Python | 3.12.3 | — | Includes pip 24.0 |
91+
| pip | 24.0 | — | Python package manager |
92+
| git | 2.52.0 | `git` | Standard git client |
93+
| GitHub CLI | 2.45.0 | `gh-cli` | `gh` command for GitHub API |
94+
| git-lfs | 3.7.1 | `git-lfs` | Git Large File Storage |
12895
| gcc | 13.3.0 | `build-essential` | C compiler |
12996
| g++ | 13.3.0 | `build-essential` | C++ compiler |
13097
| make | 4.3 | `build-essential` | Build automation |
13198
| build-essential | — | `build-essential` | Metapackage with common build tools |
132-
133-
### Network Tools
134-
135-
| Tool | Version | Package | Notes |
136-
|------|---------|---------|-------|
137-
| curl | 8.5.0 | `curl` | HTTP client (newer version) |
99+
| curl | 8.5.0 | `curl` | HTTP client |
138100
| dig | 9.18.39 | `dnsutils` | DNS lookup utility |
139101
| ifconfig | 2.10 | `net-tools` | Network interface config |
140102
| netcat | 1.226 | `netcat-openbsd` | TCP/UDP connections |
141-
142-
### System Tools
143-
144-
| Tool | Version | Package | Notes |
145-
|------|---------|---------|-------|
146103
| iptables | 1.8.10 | `iptables` | Firewall rules (host-level control) |
147104
| gosu | 1.17 | `gosu` | Run commands as other users |
148105
| capsh | — | `libcap2-bin` | Capability management |
149106
| jq | 1.6 | `jq` | JSON processor |
107+
| gnupg | — | `gnupg` | GPG encryption |
108+
| ca-certificates | — | `ca-certificates` | Trusted root certificates |
150109

151110
:::caution[Docker CLI Stub]
152111
The `docker` command is present but is a stub—there is no Docker daemon running inside the container. Docker-in-Docker is not supported. Use `--mount` to access Docker sockets from the host if needed.
153112
:::
154113

155-
## GitHub Actions Runner Compatibility
156-
157-
The `agent-act` image is based on `catthehacker/ubuntu:act-24.04`, which provides a medium-sized subset of the official GitHub Actions runner environment.
158-
159-
### What's Included
160-
161-
- Core runtimes: Node.js (multiple versions), Python, Ruby (via `/opt/hostedtoolcache`)
162-
- Build tools: gcc, g++, make, cmake
163-
- Common CLI tools: git, gh, curl, jq, aws-cli
164-
- Container tools (stubs): docker, docker-compose
165-
166-
### What's Missing
167-
168-
The medium-sized images omit some tools present in full GitHub Actions runners:
169-
170-
- Additional language runtimes (full Java, .NET SDK, Go, PHP)
171-
- Cloud provider CLIs (complete set)
172-
- Database clients (mysql, psql)
173-
- Specialized tools (terraform, helm, kubectl)
174-
175-
### Full Parity
176-
177-
For complete GitHub Actions runner parity, use the full-sized runner images (60GB+):
178-
179-
```bash
180-
sudo awf \
181-
--agent-image catthehacker/ubuntu:full-24.04 \
182-
--build-local \
183-
--allow-domains github.com \
184-
-- <command>
185-
```
186-
187-
See [catthehacker/docker_images](https://github.com/catthehacker/docker_images) for the full list of available images and their contents.
188-
189114
## Custom Base Images
190115

191116
You can use custom base images with `--agent-image`:

‎docs/agent-images.md‎

Lines changed: 20 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -51,35 +51,18 @@ sudo awf --tty --allow-domains '' -- bash
5151

5252
The default `agent` image (based on Ubuntu 22.04) includes the following pre-installed tools:
5353

54-
### Runtimes
55-
56-
| Tool | Version | Path | Notes |
57-
|------|---------|------|-------|
58-
| Node.js | v22.22.0 | `/usr/bin/node` | Includes npm, npx |
59-
| npm | 10.9.4 | `/usr/bin/npm` | — |
60-
| npx | 10.9.4 | `/usr/bin/npx` | — |
61-
| Python | 3.10.12 | `/usr/bin/python3` | No pip installed by default |
62-
63-
### Version Control & CI/CD
64-
65-
| Tool | Version | Notes |
66-
|------|---------|-------|
67-
| git | 2.34.1 | Standard git client |
68-
| GitHub CLI | 2.4.0+dfsg1 | `gh` command for GitHub API |
69-
70-
### Network Tools
71-
7254
| Tool | Version | Package | Notes |
7355
|------|---------|---------|-------|
56+
| Node.js | v22.22.0 | — | Includes npm, npx |
57+
| npm | 10.9.4 | — | — |
58+
| npx | 10.9.4 | — | — |
59+
| Python | 3.10.12 | — | No pip installed by default |
60+
| git | 2.34.1 | `git` | Standard git client |
61+
| GitHub CLI | 2.4.0+dfsg1 | `gh-cli` | `gh` command for GitHub API |
7462
| curl | 7.81.0 | `curl` | HTTP client |
7563
| dig | 9.18.39 | `dnsutils` | DNS lookup utility |
7664
| ifconfig | 2.10-alpha | `net-tools` | Network interface config |
7765
| netcat | 1.218 | `netcat-openbsd` | TCP/UDP connections |
78-
79-
### System Tools
80-
81-
| Tool | Version | Package | Notes |
82-
|------|---------|---------|-------|
8366
| iptables | 1.8.7 | `iptables` | Firewall rules (host-level control) |
8467
| gosu | 1.14 | `gosu` | Run commands as other users |
8568
| capsh | — | `libcap2-bin` | Capability management |
@@ -90,93 +73,37 @@ The default `agent` image (based on Ubuntu 22.04) includes the following pre-ins
9073

9174
## Agent-Act Image Tools
9275

93-
The `agent-act` image (based on Ubuntu 24.04) includes all tools from the `agent` image plus additional runtimes and build tools for GitHub Actions compatibility.
94-
95-
### Runtimes
96-
97-
| Tool | Version | Path | Notes |
98-
|------|---------|------|-------|
99-
| Node.js | v18.20.8 | `/opt/hostedtoolcache/node/18.20.8/x64/bin/node` | Default in PATH (from actions/setup-node) |
100-
| npm | 10.8.2 | `/opt/hostedtoolcache/node/18.20.8/x64/bin/npm` | Bundled with Node.js 18 |
101-
| npx | 10.8.2 | `/opt/hostedtoolcache/node/18.20.8/x64/bin/npx` | Bundled with Node.js 18 |
102-
| corepack | 0.32.0 | `/opt/hostedtoolcache/node/18.20.8/x64/bin/corepack` | Yarn/pnpm manager |
103-
| Node.js (system) | v22.22.0 | `/usr/bin/node` | Alternative system installation |
104-
| Python | 3.12.3 | `/usr/bin/python3` | Includes pip 24.0 |
105-
| pip | 24.0 | `/usr/bin/pip3` | Python package manager |
106-
107-
**💡 Tip:** The `agent-act` image has Node.js v18 in PATH by default (from `/opt/hostedtoolcache`) and Node.js v22 available at `/usr/bin/node`. Use `which node` to check which version is active, or specify the full path for a specific version.
108-
109-
### Version Control & CI/CD
110-
111-
| Tool | Version | Notes |
112-
|------|---------|-------|
113-
| git | 2.52.0 | Standard git client |
114-
| GitHub CLI | 2.45.0 | `gh` command for GitHub API |
115-
| git-lfs | 3.7.1 | Git Large File Storage |
116-
117-
### Build Tools
76+
The `agent-act` image (based on Ubuntu 24.04) includes the following pre-installed tools:
11877

11978
| Tool | Version | Package | Notes |
12079
|------|---------|---------|-------|
80+
| Node.js | v18.20.8 | — | Default in PATH (from `/opt/hostedtoolcache`) |
81+
| npm | 10.8.2 | — | Bundled with Node.js 18 |
82+
| npx | 10.8.2 | — | Bundled with Node.js 18 |
83+
| corepack | 0.32.0 | — | Yarn/pnpm manager |
84+
| Node.js (system) | v22.22.0 | — | Alternative system installation at `/usr/bin/node` |
85+
| Python | 3.12.3 | — | Includes pip 24.0 |
86+
| pip | 24.0 | — | Python package manager |
87+
| git | 2.52.0 | `git` | Standard git client |
88+
| GitHub CLI | 2.45.0 | `gh-cli` | `gh` command for GitHub API |
89+
| git-lfs | 3.7.1 | `git-lfs` | Git Large File Storage |
12190
| gcc | 13.3.0 | `build-essential` | C compiler |
12291
| g++ | 13.3.0 | `build-essential` | C++ compiler |
12392
| make | 4.3 | `build-essential` | Build automation |
12493
| build-essential | — | `build-essential` | Metapackage with common build tools |
125-
126-
### Network Tools
127-
128-
| Tool | Version | Package | Notes |
129-
|------|---------|---------|-------|
130-
| curl | 8.5.0 | `curl` | HTTP client (newer version) |
94+
| curl | 8.5.0 | `curl` | HTTP client |
13195
| dig | 9.18.39 | `dnsutils` | DNS lookup utility |
13296
| ifconfig | 2.10 | `net-tools` | Network interface config |
13397
| netcat | 1.226 | `netcat-openbsd` | TCP/UDP connections |
134-
135-
### System Tools
136-
137-
| Tool | Version | Package | Notes |
138-
|------|---------|---------|-------|
13998
| iptables | 1.8.10 | `iptables` | Firewall rules (host-level control) |
14099
| gosu | 1.17 | `gosu` | Run commands as other users |
141100
| capsh | — | `libcap2-bin` | Capability management |
142101
| jq | 1.6 | `jq` | JSON processor |
102+
| gnupg | — | `gnupg` | GPG encryption |
103+
| ca-certificates | — | `ca-certificates` | Trusted root certificates |
143104

144105
**⚠️ Docker CLI Stub:** The `docker` command is present but is a stub—there is no Docker daemon running inside the container. Docker-in-Docker is not supported. Use `--mount` to access Docker sockets from the host if needed.
145106

146-
## GitHub Actions Runner Compatibility
147-
148-
The `agent-act` image is based on `catthehacker/ubuntu:act-24.04`, which provides a medium-sized subset of the official GitHub Actions runner environment.
149-
150-
### What's Included
151-
152-
- Core runtimes: Node.js (multiple versions), Python, Ruby (via `/opt/hostedtoolcache`)
153-
- Build tools: gcc, g++, make, cmake
154-
- Common CLI tools: git, gh, curl, jq, aws-cli
155-
- Container tools (stubs): docker, docker-compose
156-
157-
### What's Missing
158-
159-
The medium-sized images omit some tools present in full GitHub Actions runners:
160-
161-
- Additional language runtimes (full Java, .NET SDK, Go, PHP)
162-
- Cloud provider CLIs (complete set)
163-
- Database clients (mysql, psql)
164-
- Specialized tools (terraform, helm, kubectl)
165-
166-
### Full Parity
167-
168-
For complete GitHub Actions runner parity, use the full-sized runner images (60GB+):
169-
170-
```bash
171-
sudo awf \
172-
--agent-image catthehacker/ubuntu:full-24.04 \
173-
--build-local \
174-
--allow-domains github.com \
175-
-- <command>
176-
```
177-
178-
See [catthehacker/docker_images](https://github.com/catthehacker/docker_images) for the full list of available images and their contents.
179-
180107
## Custom Base Images
181108

182109
You can use custom base images with `--agent-image`:

0 commit comments

Comments
 (0)