> ## Documentation Index
> Fetch the complete documentation index at: https://docs.d0pam1ne.blackhatethicalhacking.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI reference

> Every d0pam1ne command and flag: recon, attack, projects, scope, tools, wordlists and diagnostics.

The engine is driven by the `d0pam1ne` command. Run it with no arguments for the interactive console, or use the subcommands below. Global flags: `--no-banner`, `--version` / `-V`, `-h` / `--help`.

## Recon

Run the recon pipeline on the current project.

```bash theme={null}
d0pam1ne recon [--profile fast|stealth|normal|deep] [--only STAGES] [--skip STAGES] [--resume] [--yes]
```

**--project SLUG**

Project to run (default: the current project).

**--profile** (default: normal)

Pacing profile: `fast`, `stealth`, `normal` or `deep`. See [profiles](/engine/profiles.md).

**--only STAGES**

Comma-separated stages to run, from `subdomains,active,dns,ports,pivot,services,web,waf,tls,fingerprint,screenshots,urls,content,params,js`.

**--skip STAGES**

Comma-separated stages to skip.

**--resume**

Continue the last unfinished run.

**--yes / -y**

Confirm authorization without being asked.

**--plain**

Plain line output instead of the live screen.

**--nmap-options STR**

nmap options for this run, e.g. `"-sS -sV -sC -O -A -Pn"`.

**--protocols tcp|udp|both**

nmap TCP, UDP or both (UDP needs privileges).

```bash theme={null}
# A quick, authorized run of just the surface
d0pam1ne recon --profile fast --only subdomains,dns,ports,web --yes

# Resume an interrupted deep run
d0pam1ne recon --profile deep --resume
```

## Control a running recon

```bash Pause theme={null}
# Wind down the tools running now; resume with recon --resume
d0pam1ne pause
```

```bash Stop one tool theme={null}
# Stop a single tool (or "all"); the run carries on with what it found
d0pam1ne stop-tool feroxbuster
```

## Results and reporting

```bash theme={null}
d0pam1ne results [--run ID]        # show the results of the last (or a given) run
d0pam1ne report  [--run ID] [--open]   # one-page HTML summary, saved in the run folder
d0pam1ne attack  [category]        # in-scope target lists and tested commands (nothing runs)
```

## Projects

```bash theme={null}
d0pam1ne project new --name "Acme" --client "Acme Inc" --in "*.acme.com" --in "203.0.113.0/24"
d0pam1ne project list
d0pam1ne project use acme
d0pam1ne project show
d0pam1ne project scope --in "api.acme.com" --remove "staging.acme.com"
d0pam1ne project nmap --preset aggressive --protocols both
d0pam1ne project settings --set naabu.ports=full --set katana.depth=3
d0pam1ne project check https://app.acme.com   # is this target in scope? (exit 3 if not)
```

**project settings --set TOOL.KEY=VALUE**

Override one tool's behavior for this project, e.g. `naabu.ports=full`, `gau.enabled=off`. Repeatable. `--reset TOOL` (or `all`) clears overrides.

**project nmap --preset**

`aggressive`, `standard`, `light` or `thorough`, or pass raw `--options "..."`.

## Scope

```bash theme={null}
# What recon will do for each rule, before a run
d0pam1ne scope plan --in "*.acme.com" --out "staging.acme.com" --json
```

## Tools and wordlists

```bash theme={null}
d0pam1ne doctor [--missing] [--nmap] [--json]   # check tools and system
d0pam1ne tools list
d0pam1ne tools install --core      # the default pipeline
d0pam1ne tools install --all       # recon, OSINT and attack
d0pam1ne tools install --attack    # just the attack set
d0pam1ne tools update
d0pam1ne wordlists status
d0pam1ne wordlists install [--full]   # SecLists (core folders, or ~2 GB full)
d0pam1ne update [--check]          # update the engine itself from GitHub
```

## Exit codes

| Code | Meaning |
| - | - |
| 0 | Success |
| 2 | Usage or input error |
| 3 | Scope check failed (`project check`) |
| 130 | Interrupted (Ctrl-C) |
| 1 | General failure |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.