winget install --id=Urlscan.urlscan-cli -e urlscan-cli lets you interact with the urlscan.io API from the command line, including submitting scans, retrieving results, and managing account data.
The official urlscan CLI.
The built binaries can be found on the releases page.
> [!NOTE]
> Apple's Gatekeeper may prevent the binary from running.
> Use xattr -c urlscan to unblock it or install via Homebrew Cask (see below).
Homebrew Cask is supported for macOS/Linux:
brew install --cask urlscan/tap/urlscan-cli
> [!NOTE] > There is a WinGet package but it's not maintained by urlscan. > Use at your own risk. For any issues regarding the WinGet package, please report them to the winget-pkgs repository and not here
See the docs.
There are two ways for configuring your API key:
URLSCAN_API_KEY environment variable> [!NOTE] > Ordered by the higher precedence.
If you want to use the keyring, you can set it via the terminal or via standard input:
$ urlscan key set
Enter a urlscan.io API key:
# or
$ echo "" | urlscan key set -
> [!NOTE] > Keyring suport for Linux depends on GNOME Keyring. See troubleshooting for details.
urlscan scan submit
urlscan scan result
urlscan search
Alternatively, you can pass an argument via the standard input by passing -.
echo "" | urlscan scan result -
See urlscan --help and also the document for more details.
HTTP_PROXY and HTTPS_PROXY environment variables are respected by default. Additionally, you can set the proxy via the option:
--proxyurlscan --proxy http://proxy:1234