projectdiscovery/katana

Maintainer? Show your league in your README

Card: your league's emblem, from Copper to Legendary

[![bestofgithub](https://bestofgithub.dev/badge/projectdiscovery/katana.svg?style=card)](https://bestofgithub.dev/repo/projectdiscovery/katana)

Flat: fits beside your other badges

[![bestofgithub](https://bestofgithub.dev/badge/projectdiscovery/katana.svg)](https://bestofgithub.dev/repo/projectdiscovery/katana)

Loading README…

Mode	Flag	Best for
`simhash` (default)	`-pcsm simhash`	Near-duplicate / template clones (Hamming via `-pcsd`)
`tfidf`	`-pcsm tfidf`	Topical cosine similarity (`-pcst`)
`bm25`	`-pcsm bm25`	Topical similarity with length normalization (`-pcst`)

Strategy	Description
`heuristic`	(default) Smart waiting that adapts to page behavior - waits for load event, network idle, and DOM stability
`load`	Waits only for the browser's load event
`domcontentloaded`	Waits for DOMContentLoaded event plus additional time (configurable via `-dwt`) for JavaScript rendering
`networkidle`	Waits for network activity to stop
`none`	No waiting - returns immediately after navigation starts

Operating System	Chromium Executable Location	Google Chrome Executable Location
Windows (64-bit)	`C:\Program Files (x86)\Google\Chromium\Application\chrome.exe`	`C:\Program Files (x86)\Google\Chrome\Application\chrome.exe`
Windows (32-bit)	`C:\Program Files\Google\Chromium\Application\chrome.exe`	`C:\Program Files\Google\Chrome\Application\chrome.exe`
macOS	`/Applications/Chromium.app/Contents/MacOS/Chromium`	`/Applications/Google Chrome.app/Contents/MacOS/Google Chrome`
Linux	`/usr/bin/chromium`	`/usr/bin/google-chrome`

FIELD	DESCRIPTION	EXAMPLE
`url`	URL Endpoint	`https://admin.projectdiscovery.io/admin/login?user=admin&password=admin`
`qurl`	URL including query param	`https://admin.projectdiscovery.io/admin/login.php?user=admin&password=admin`
`qpath`	Path including query param	`/login?user=admin&password=admin`
`path`	URL Path	`https://admin.projectdiscovery.io/admin/login`
`fqdn`	Fully Qualified Domain name	`admin.projectdiscovery.io`
`rdn`	Root Domain name	`projectdiscovery.io`
`rurl`	Root URL	`https://admin.projectdiscovery.io`
`ufile`	URL with File	`https://admin.projectdiscovery.io/login.js`
`file`	Filename in URL	`login.php`
`key`	Parameter keys in URL	`user,password`
`value`	Parameter values in URL	`admin,admin`
`kv`	Keys=Values in URL	`user=admin&password=admin`
`dir`	URL Directory name	`/admin/`
`udir`	URL with Directory	`https://admin.projectdiscovery.io/admin/`

A next-generation crawling and spidering framework

Features

Installation

Usage

Running Katana

Input for katana

URL Input

Multiple URL Input (comma-separated)

List Input

STDIN (piped) Input

Page Content Similarity

Crawling Mode

Standard Mode

Headless Mode

Interactive UI exploration

-no-sandbox

-no-incognito

-headless-options

-page-load-strategy

-dom-wait-time

Captcha Solving

-captcha-solver-provider

-captcha-solver-key

Scope Control

-field-scope

-crawl-scope

-crawl-out-scope

-no-scope

-display-out-scope

Crawler Configuration

-depth

-js-crawl

-crawl-duration

-known-files

-automatic-form-fill

-filter-similar

-max-domain-pages

Knowledge Base Classification

-knowledge-base

-filter-page-type

-kb-secrets

-kb-endpoints

Authenticated Crawling

Headers / cookies

-headers

Automatic login (-auto-login)

Recorded flow (-recorded-flow)

Connecting to Active Browser Session

Filters

-field

Custom Fields

Running katana using custom field:

-store-field

Katana Filters

-extension-match

-extension-filter

-no-default-ext-filter

-match-regex

-filter-regex

Advance Filtering

Rate Limit

-delay

-concurrency

-parallelism

-rate-limit

-rate-limit-minute

-host-rate-limit

-host-rate-limit-minute

Output

-output

-output-template

-jsonl

-store-response

-list-output-fields

-exclude-output-fields

Katana as a library

Reporting Issues & Feature Requests

`-no-sandbox`

`-no-incognito`

`-headless-options`

`-page-load-strategy`

`-dom-wait-time`

`-captcha-solver-provider`

`-captcha-solver-key`

`-field-scope`

`-crawl-scope`

`-crawl-out-scope`

`-no-scope`

`-display-out-scope`

`-depth`

`-js-crawl`

`-crawl-duration`

`-known-files`

`-automatic-form-fill`

`-filter-similar`

`-max-domain-pages`

`-knowledge-base`

`-filter-page-type`

`-kb-secrets`

`-kb-endpoints`

`-headers`

Automatic login (`-auto-login`)

Recorded flow (`-recorded-flow`)

`-field`

`-store-field`

`-extension-match`

`-extension-filter`

`-no-default-ext-filter`

`-match-regex`

`-filter-regex`

`-delay`

`-concurrency`

`-parallelism`

`-rate-limit`

`-rate-limit-minute`

`-host-rate-limit`

`-host-rate-limit-minute`

`-output`

`-output-template`

`-jsonl`

`-store-response`

`-list-output-fields`

`-exclude-output-fields`