Home › Documentation
Documentation
The manual is organised the way the toolkit is used: get it installed, configure the defaults once, run the tools, and look up individual commands as needed. Every command reference page lists the tool's flags as of the current release, with real examples.
Contents
| Page | What it covers |
|---|---|
| Installation | Requirements, building from source, install.sh, updating, uninstalling, state and report directories. |
| Configuration | The settings editor, saved defaults, the twelve built-in impairment profiles, scenario scripts, per-target overrides. |
| Usage | Worked recipes: shape a host, watch the LAN, scan the network, the watch-to-test hand-off, --json feeds. |
| gnulte(8) | The core shaping engine — targeting, impairment parameters, profiles, capture, reports. |
| gnulte-lan(8) | The live LAN watch — the six screens, keys, alarms, CSV/JSON export, history. |
| gnulte-scan(8) | Sweep and deep scan — port scanner, fingerprinting, --watch, output formats. |
| gnulte-devices(8) | Instant ARP/neighbour inventory — vendors, hostnames, reports, no root. |
| gnulte-wifi(8) | 802.11 deauthentication testing — monitor mode, bursts, reason codes, jitter, hopping. |
| gnulte-doctor(8) | Pre-flight health check — the checks it performs and how to read the result. |
| gnulte-trace(8) | Hop-by-hop path probing — options, per-hop statistics, HTML report. |
| gnulte-top(8) | Live bandwidth accounting — hosts, flows, sampling, CSV/JSON snapshots. |
| Troubleshooting | Run gnulte-doctor first; privileges, tc/iptables, ip_forward, kernel modules, filtered ICMP, capture permissions. |
| FAQ | Platform support, root requirements, external tools, where data lives, safety records. |
Conventions
- Flags
- Shown as
--long-name VALUEor-l VALUE. Go's flag parser accepts both-flagand--flagfor every option. Command references are written against v16.13; run<tool> -hif you are running a different version. - Examples
- Addresses such as
192.168.1.0/24stand for your own subnet. Replace them with the network you are authorised to test. - Root
- Tools that shape, spoof, inject or capture say so on their reference page. Every tool works unprivileged where that is technically possible.
Also in the repository:
README.md (release notes for the Go
edition), docs/V17-PLAN.md (the Unplugged development plan) and the
safety documents printed by gnulte --docs.