getallurls (gau)

You can install gau using several methods:

From source

Use go install to install the latest version:

go install github.com/lc/gau/v2/cmd/gau@latest

From GitHub

Clone the repository and build the binary manually:

git clone https://github.com/lc/gau.git; \
cd gau/cmd; \
go build; \
sudo mv gau /usr/local/bin/;
gau --version;

From binary

Download pre-built binaries from the releases page, extract them, and move the binary to your $PATH:

tar xvf gau_2.0.6_linux_amd64.tar.gz
mv gau /usr/bin/gau

From Docker

Run the tool directly using the official image:

docker run --rm sxcurity/gau:latest --help

Or build your own image:

docker build -t gau .
docker run gau example.com

Note: Piping commands (e.g., echo "example.com" | gau) will not work with the Docker container.

The gau tool fetches known URLs from AlienVault's Open Threat Exchange, the Wayback Machine, Common Crawl, and URLScan for a given domain.

Basic Usage Examples

Fetch from stdin:

printf example.com | gau

Fetch from a file:

cat domains.txt | gau --threads 5

Fetch multiple domains:

gau example.com google.com

Save results to a file:

gau --o example-urls.txt example.com

Filter by file extensions (blacklist):

gau --blacklist png,jpg,gif example.com

By default, gau looks for a configuration file at $HOME/.gau.toml or %USERPROFILE%\.gau.toml.

• Options specified in the config file are used for every run.
• Command line flags will override any options set in the configuration file.
• If no configuration file is found, gau will run with default settings and output a message to stderr.

You can specify an alternate configuration file using the --config flag.

gau --config $HOME/.config/gau.toml

If you use ohmyzsh with the git plugin, there is a known alias that maps gau to git add --update. This causes a binary conflict when trying to run the gau tool.

Workarounds can be found in the official GitHub issue.

The httpclient package defines specific error variables to identify common failure scenarios during requests:

var (
	ErrNilResponse    = errors.New("unexpected nil response")
	ErrNon200Response = errors.New("API responded with non-200 status code")
	ErrBadRequest     = errors.New("API responded with 400 status code")
)

The gau (getallurls) CLI tool fetches URLs from various providers for a given set of domains. It accepts domains as command-line arguments or via stdin.

Input Methods:

1. Command-line arguments: Pass domains directly as arguments.
2. Standard Input (stdin): Pipe a list of domains into the command.

Output Modes:

• Standard Output: By default, results are printed to stdout.
• File Output: Configure an output file via the configuration settings.
• JSON Format: Results can be emitted in JSON format instead of plain text.

The Header struct is used to pass custom HTTP headers to the MakeRequest function. It requires a Key and a Value.

type Header struct {
	Key   string
	Value string
}