CLI - Introduction

Our official CLI brings the full capabilities of our platform to your terminal.

Key Features

• Comprehensive API support: The CLI supports all our free and pro API endpoints.
• Bulk submissions: Instead of scanning links individually, scan multiple URLs at once.
• Automatic search iteration: Retrieve large datasets by automatically iterating a search.
• Cross-platform support: urlscan-cli is implemented in go and is available for Windows, macOS, and Linux.

The majority of commands in urlscan-cli will return raw JSON responses. You will likely want to parse these with a tool like jq. Note that some functionality will require a urlscan Pro account.

Documentation

For the full documentation please visit the urlscan-cli Github page.

Installation

Installation is straightforward with multiple options available:

• Pre-built binaries are available for all platforms on GitHub releases.
• macOS users should install via Homebrew:

brew install --cask urlscan/tap/urlscan-cli

Once installed, start by setting up your urlscan API key. You can generate an API key on the User page on urlscan.io.

# Set the API key via keyring
urlscan key set


# Alternatively you can simply supply the API key via the environment
export URLSCAN_API_KEY=xxx

Support

For any suggestions about improvements or further functionality we would love to get your feedback on the urlscan-cli Github project.