Skip to content

CLI Reference

Complete reference for all command-line arguments available in AtDork.


Quick Overview

Flag Type Default Description
-q, --query String None Main search query (dork)
-r, --max-results Integer 20 Max results per engine (1-100)
--batch-file Path None File with one dork per line
--batch-separator String ; Separator for inline multiple queries
-o, --output Path None Output file path
--output-dir Path None Output directory for per-query files
--format Choice txt Output format: txt, json, csv
-v, --verbose Boolean false Show results during batch mode
--no-snippet Boolean false Hide snippets in terminal output
--template String None Template name(s), comma-separated
--target String None Domain for {target} substitution
--select String None Select specific dorks from template (e.g., 1,3,5)
--list-templates Boolean false List all available templates
--template-path Path None Custom template directory
--preview Boolean false Preview template dorks without executing
--region Choice us-en Search region
--safesearch Choice moderate SafeSearch level: on, moderate, off
--timelimit Choice None Time filter: d, w, m, y
--backend String auto Search engine(s), comma-separated — scraping backends, API engines (serper, serpapi, brave), or a profiles: name. See Engines & Providers.
--user-agent String None Custom User-Agent (auto-rotate if None)
--timeout Integer 10 Request timeout in seconds
--retries Integer 2 Retry attempts on failure
--delay Float 0 Delay between requests (seconds)
--proxy String None Comma-separated proxy URLs
--proxy-file Path None File with proxy URLs (one per line)
--tor Boolean false Use Tor SOCKS5 proxy
--strict Boolean false Fail if all proxies are down (no direct fallback)
--proxy-cooldown Integer 60 Cooldown after proxy failure (seconds)
--max-failures Integer 3 Remove proxy after N consecutive failures
--concurrency Integer 1 Number of parallel threads (1-10)
--max-fallback-failures Integer 3 Failures before fallback to sequential
--resilient Boolean false Enable circuit breaker & backend fallback
--adaptive-delay Boolean false Enable adaptive rate limiting
--ip-guard Boolean false Enable IP leak detection (requires --strict)
--exec String None Execute command on each result ({} = URL)
--exec-on-vuln String None Execute command only on vulnerable results
--exec-parallel Integer 1 Parallel processes for --exec
--exec-timeout Integer 30 Timeout per --exec command (seconds)
--no-validate Boolean false Disable all spam/invalid filtering
--strict-filter Boolean false Strict validation (title≥5, desc≥10)
--validate-url Choice all URL mode: only, path, params, all, false
--validate-title String 5 Min title length or false to disable
--validate-desc String 10 Min description length or false to disable
--validate-spam Boolean true Enable spam detection
--filter-vuln String None Vulnerability platform filter
--database-dork String None Load dorks from Atdork-DB ref(s), e.g. @ghdb/01_footholds
--database-preview Boolean false Preview loaded dorks without running them
--database-r Integer None Randomly select N dorks from the loaded set
--database-seed Integer None RNG seed for reproducible --database-r selection
--database-path Path None Custom database root (default: discovered Atdork-DB checkout)
--database-dork-extract Path None Extract a ref to PATH (shortcut for the extract flow, v1.3.9.5+)
--list-database-dork Boolean false List all available database dork files
--db-repo Path None Atdork-DB checkout path (default: auto-discover or config db_repo)
--db-repo-url String None Git URL of the Atdork-DB repository
--package-dir Path ~/.atdork/packages Local package store directory
--no-fallback-backends Boolean false Disable backend fallback
--no-verify Boolean false Disable SSL certificate verification
--log-file Path atdork.log Log file path
--db-path Path atdork.db SQLite database path
--resume Boolean false Resume pending queries from database
--history Boolean false Show search history
--no-dedup Boolean false Disable URL deduplication
--export-db Path None Export database to file (json/csv)
--config Path None YAML config file path
--env Path None Environment root — all results/logs/cache/state stay inside it (Environment)
--interactive Boolean false Run interactive mode
--debug Boolean false Enable debug logging
--version None None Show version and exit
-h, --help None None Show help message and exit

Package Subcommands

The built-in package manager treats Atdork-DB — 123 packages, 31 @folders, ~994,600 dorks — like a package registry. Browse packages in the web catalog or with atdork search / atdork index.

Subcommand Description
atdork search <keyword> Filter the package index by keyword (ref, folder, description).
atdork index List every package: ref \| dorks \| size \| description.
atdork install <ref> Copy a package into the local store (~/.atdork/packages).
atdork uninstall <ref> Remove an installed package.
atdork installed List installed packages in the local store.
atdork update git pull --ff-only on the Atdork-DB checkout.

Package refs accept several forms — see Dork Database for the full grammar:

atdork search shodan                # find packages
atdork install @cve/cve_1.txt       # canonical: folder + file
atdork install c@cve_1.txt          # shorthand (unique folder prefix)
atdork install @ghdb                # whole folder
atdork installed                    # verify the store
atdork update                       # refresh the database checkout

Environment Subcommands

Manage isolated workspaces — every file AtDork writes stays inside the environment root. Full guide: Environment.

Subcommand Description
atdork env create <path> [--name N] Create the workspace layout + marker (idempotent; init is an alias).
atdork env list List registered environments.
atdork env use <path> Set the default active environment.
atdork env which Show the resolved environment and its owned paths.
atdork env info Size per area, results count, DB clone status.
atdork env destroy <path> [--delete] Unregister (keep files) or delete the folder.
atdork env create ~/osint-job        # one-time
atdork env use ~/osint-job           # default for every command
atdork -q "inurl:admin"              # results land in <root>/results/
atdork --env /other/job -q "..."     # per-command override

Installed packages run as batch files (--batch-file c@cve_1.txt); any ref also loads directly from the database root via --database-dork (see below).

Workflow Subcommands

Run sequential multi-step dork campaigns defined in YAML. Full guide: Workflows.

Subcommand Description
atdork workflow list List available workflows (config workflows: + discovered files).
atdork workflow validate [name] Validate definitions (schema, substitutions, targets). Exit 1 on errors.
atdork workflow run <name> Run a workflow. <name> may also be a file path or . (the single workflow found in the root).
Flag (on run) Description
--file FILE Workflow YAML file(s), repeatable (also on list/validate).
--target TARGET Override the workflow target ({target} substitution).
--workers N Override the worker (thread) count for every step.
--step NAME Run only this step.
--resume Skip steps already completed in the saved state.
--dry-run Print resolved queries without searching.

One-shot flags on the main command (same engine, no subcommand):

Flag Description
--run-workflow NAME Run a workflow by name, file path, or . for the single workflow discovered in the root.
--workflow-file FILE Read workflow definitions from this file.
--workflow-target TARGET Override the workflow target.
--workflow-workers N Override the worker (thread) count.
--workflow-resume Resume: skip completed steps.
--workflow-dry-run Print resolved queries without searching.
atdork workflow list                     # what's defined?
atdork workflow validate                 # schema check, no credits spent
atdork --run-workflow .                  # run the single workflow in ./workflow.yaml
atdork workflow run recon-acme --target example.com --workers 2
atdork workflow run recon-acme --resume   # continue after a failed/stopped run

Workflow files named workflow.yaml (etc.) in the active environment root or the working directory are discovered automatically; the environment root wins on name collisions.


Watch Subcommands

One-shot monitoring: register dorks, then report only the new findings each cycle. Full guide: Watch Mode.

Subcommand Description
atdork watch add <name> Create (or extend) a watch: --dork, --batch-file, --database-dork, --notify.
atdork watch list List watches with their source summary and last run.
atdork watch show <name> Show the definition, options, history counters and last new URLs.
atdork watch run <name> Run one cycle (cron-friendly). --all runs every watch.
atdork watch remove <name> Delete the watch and its history.
Flag (on add / run) Description
--dork DORK Dork to run (repeatable on add).
--batch-file FILE File of dorks, one per line (repeatable on add).
--database-dork SPEC Database dork spec, e.g. @ghdb/01_footholds.
--notify TARGET Webhook target (discord: / slack: / telegram:). Stored on add, overridable on run.
--backend, --max-results, --timeout, --retries, --delay, --region, --safesearch, --timelimit Search options (stored on add, overridable on run).
--dry-run (run) Resolve the dorks and exit — nothing searched.
--concurrency N (run) Parallel dork workers (default 1).
--all (run) Run every saved watch.
atdork watch add acme --dork "site:acme.com ext:env" --notify discord:https://…
atdork watch run acme              # first run = baseline, later runs report the delta
atdork watch run acme --dry-run    # sanity-check the dorks, no credits spent
atdork watch run --all             # one cycle for every watch

State lives in <env>/state/watch/<name>.json; runs never use the search cache, and a quiet cycle (no new findings) sends no notification.


Plugin Subcommands

Installable Python tools that surface as --<plugin>-<option> flags on the main command. Full guide: Plugins.

Subcommand Description
atdork plugins list List discovered plugins with status (ready / disabled / invalid).
atdork plugins info <name> Show a plugin's contract, flags, dests, and path.
atdork plugins run <name> [--opt KEY=VALUE] Run a plugin without the flag syntax.
atdork plugins publish <ref> Print Index.idn lines for a tool folder (--write updates the file).
atdork plugins sources List third-party registries configured under plugins.sources.
atdork install @plugins/dorkbuilder              # install a tool folder
atdork install https://github.com/user/repo#tool # or from a git repo
atdork install --source mine @plugins/tool       # or from your own registry
atdork --dorkbuilder-text "John wick" --dorkbuilder-save dorks.txt
atdork plugins run dorkbuilder --opt text=Acme --opt limit=3
atdork plugins publish @plugins/dorkbuilder --write

atdork install also accepts --git-ref BRANCH to pin a repository URL to a branch or tag, and --source NAME to install from a registry declared in plugins.sources.

Every option is registered as --<plugin>-<option> (the engine prefixes short option names itself). A plugin runs via the bare --<plugin> trigger or implicitly when any --<plugin>-* argument is present.


Detailed Flag Descriptions

Query & Results

Flag Description
-q, --query Main search query (dork). Can be combined with --batch-separator for multiple queries.
-r, --max-results Maximum number of results to return per query. Values above 100 are automatically clamped.
--batch-file Path to a text file containing one dork per line. Lines starting with # are ignored.
--batch-separator Separator for splitting a single -q string into multiple queries. Default is ;.

Output Options

Flag Description
-o, --output Save all results to a single file. Format determined by --format or file extension.
--output-dir Save each query's results to a separate file in the specified directory.
--format Output format: txt (human-readable), json (structured), csv (spreadsheet).
-v, --verbose Display results in real-time during batch processing.
--no-snippet Hide result snippets in terminal output for cleaner display.

Templates

Flag Description
--template Load one or more YAML templates (comma-separated). Example: --template sqli,wordpress
--target Domain to substitute for {target} placeholder in template dorks.
--select Run only specific dorks from a template (1-based indices). Example: --select 1,3,5
--list-templates Display all available templates with descriptions.
--template-path Custom directory to search for template files.
--preview Show template dorks without executing them. Useful for validation.

Search Engine Settings

Flag Description
--region Search region/language code. Examples: us-en, uk-en, de-de, ru-ru.
--safesearch Filter adult content: on (strict), moderate (default), off (none).
--timelimit Restrict results by time: d (day), w (week), m (month), y (year).
--backend Search engine(s) to use. Options: google, bing, duckduckgo, startpage, yandex, auto, a comma-separated list — or an API engine configured under engines: in atdork.yml (serper, serpapi, brave) or a profiles: chain name. See Engines & Providers.

Request Tuning

Flag Description
--user-agent Custom User-Agent string. If not provided, AtDork rotates through a built-in pool.
--timeout Request timeout in seconds. Increases progressively with retries.
--retries Number of retry attempts per backend before moving to the next.
--delay Fixed delay between requests in seconds. Overridden by --adaptive-delay if enabled.

Proxy & Anonymity

Flag Description
--proxy Comma-separated list of proxy URLs. Format: scheme://[user:pass@]host:port.
--proxy-file Path to a file containing proxy URLs (one per line). Lines starting with # are ignored.
--tor Enable Tor SOCKS5 proxy at socks5h://127.0.0.1:9050.
--strict Fail closed – if all proxies fail, AtDork exits with error instead of falling back to direct connection.
--proxy-cooldown Seconds to wait before retrying a failed proxy (default: 60).
--max-failures Number of consecutive failures before a proxy is permanently removed (default: 3).
--ip-guard Enable IP leak detection. Requires --strict. AtDork stops if your real IP is exposed.

Concurrency & Resilience

Flag Description
--concurrency Number of parallel threads for batch processing (1-10). Higher values = faster but more likely to hit rate limits.
--max-fallback-failures Consecutive failures before falling back from parallel to sequential mode.
--resilient Enable intelligent fault-tolerance: circuit breaker, backend fallback, and automatic retry.
--adaptive-delay Dynamically adjust request delay based on real-time backend response codes.

Post-Processing

Flag Description
--exec Execute a shell command on each result URL. Use {} as placeholder for the URL. Example: --exec "curl -I {}"
--exec-on-vuln Execute command only on results flagged as vulnerable by --filter-vuln.
--exec-parallel Number of parallel processes for --exec commands. Default: 1.
--exec-timeout Timeout in seconds for each --exec command. Default: 30.

Validation & Filtering

Flag Description
--no-validate Disable all spam/invalid result filtering. Keeps raw results.
--strict-filter Enable strict validation: title ≥ 5 chars, description ≥ 10 chars, spam detection on, URL all mode.
--validate-url URL validation mode: only (domain only), path (domain+path), params (domain+params), all (full), false (disabled).
--validate-title Minimum title length. Set to false to disable title validation.
--validate-desc Minimum description length. Set to false to disable description validation.
--validate-spam Enable/disable spam detection. Default: true.
--filter-vuln Filter results by vulnerability platform. Examples: wordpress, joomla, sqli, wordpress-link.

Database & History

Flag Description
--db-path Path to SQLite database file. Default: atdork.db.
--resume Resume pending or failed queries from the database.
--history Display search history with query text and status.
--no-dedup Disable global URL deduplication. Keeps all results.
--export-db Export entire database to JSON or CSV. Example: --export-db all_results.json

Dork Database & Package Manager

Load dorks straight from the Atdork-DB checkout without installing them first. Full workflow and the package list: Dork Database.

Flag Description
--database-dork SPEC Load dorks from database ref(s). Comma-separated, folder or file level. Example: --database-dork @ghdb/01_footholds,@lfi.
--database-preview Show the loaded dorks without executing them. Requires --database-dork.
--database-r N Randomly select N dorks from the loaded set before running.
--database-seed N Seed the RNG used by --database-r for reproducible selection.
--database-path PATH Custom database root directory (instead of the discovered checkout).
--database-dork-extract PATH Extract a ref to PATH instead of running it (v1.3.9.5+).
--list-database-dork List every dork file available in the database and exit.
--db-repo PATH Point the package manager at a specific Atdork-DB checkout. Overrides discovery.
--db-repo-url URL Git URL of the Atdork-DB repository (used by clone/update helpers).
--package-dir PATH Local package store directory. Default: ~/.atdork/packages.
atdork --list-database-dork                                   # what's available?
atdork --database-dork @cve --database-preview                # show, don't run
atdork --database-dork @ghdb/01_footholds -r 20               # run a file
atdork --database-dork @cms --database-r 50 --database-seed 7 # random 50, reproducible

Logging & Debugging

Flag Description
--log-file Path to log file. Default: atdork.log.
--debug Enable debug logging (more verbose output).
--no-verify Disable SSL certificate verification (not recommended).
--no-fallback-backends Disable automatic backend fallback on failure.

Configuration & Mode

Flag Description
--config Path to YAML configuration file (schema v2). Files are layered global → working dir → --config (see Configuration); CLI flags override YAML values. Env alternative: ATDORK_CONFIG.
--interactive Launch interactive mode with prompts instead of CLI flags.
--version Display version and exit.
-h, --help Display help message and exit.

Flag Categories

By Purpose

Category Flags
Core -q, -r, --batch-file, --template, --interactive
Output -o, --output-dir, --format, -v, --no-snippet
Search --region, --safesearch, --timelimit, --backend
Network --user-agent, --timeout, --retries, --delay, --no-verify
Proxy --proxy, --proxy-file, --tor, --strict, --proxy-cooldown, --max-failures, --ip-guard
Resilience --resilient, --adaptive-delay, --concurrency, --max-fallback-failures, --no-fallback-backends
Filter --filter-vuln, --no-validate, --strict-filter, --validate-url, --validate-title, --validate-desc, --validate-spam
Dork DB --database-dork, --database-preview, --database-r, --database-seed, --database-path, --database-dork-extract, --list-database-dork
Packages --db-repo, --db-repo-url, --package-dir + subcommands search, install, uninstall, installed, update, index
Workflow --run-workflow, --workflow-file, --workflow-target, --workflow-workers, --workflow-resume, --workflow-dry-run + subcommands list, validate, run
Post-Process --exec, --exec-on-vuln, --exec-parallel, --exec-timeout
Database --db-path, --resume, --history, --no-dedup, --export-db
Template --template, --target, --select, --list-templates, --template-path, --preview
Debug --log-file, --debug, --config
Info --version, -h