urlscan

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 10, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

README

URLScan.io

Scan URLs for malicious content, phishing, and other threats using urlscan.io.

Configuration

Environment Variable CLI Flag Required Description
WARREN_URLSCAN_API_KEY --urlscan-api-key Yes URLScan.io API key
WARREN_URLSCAN_BASE_URL --urlscan-base-url No Base URL (default: https://urlscan.io/api/v1)
WARREN_URLSCAN_BACKOFF --urlscan-backoff No Polling backoff interval (default: 3s)
WARREN_URLSCAN_TIMEOUT --urlscan-timeout No Scan timeout (default: 30s)

Available Functions

Function Description
urlscan_scan Submit a URL for scanning. The scan runs asynchronously with polling until results are available or the timeout is reached.

Setup

  1. Create an account at urlscan.io
  2. Navigate to Settings & API > API Keys
  3. Create a new API key
  4. Set WARREN_URLSCAN_API_KEY environment variable

The tool is automatically enabled when the API key is configured.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Action

type Action struct {
	// contains filtered or unexported fields
}

func (*Action) Configure

func (x *Action) Configure(ctx context.Context) error

func (*Action) Flags

func (x *Action) Flags() []cli.Flag

func (*Action) Helper

func (x *Action) Helper() *cli.Command

func (*Action) LogValue

func (x *Action) LogValue() slog.Value

func (*Action) Name

func (x *Action) Name() string

func (*Action) Prompt

func (x *Action) Prompt(ctx context.Context) (string, error)

Prompt returns additional instructions for the system prompt

func (*Action) Run

func (x *Action) Run(ctx context.Context, name string, args map[string]any) (map[string]any, error)

func (*Action) Specs

func (x *Action) Specs(ctx context.Context) ([]gollem.ToolSpec, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL