#![allow(clippy::doc_markdown)]
use std::path::PathBuf;
use clap::CommandFactory;
use clap::Parser;
pub const DEFAULT_USER_AGENT: &str = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36";
pub const ACCEPTABLE_USE_HELP: &str = "Scan only hosts you are authorized to scan.";
#[derive(Debug, Parser, Clone)]
#[command(
name = "domain-status",
about = "Concurrent URL scanner; results in SQLite.",
after_help = ACCEPTABLE_USE_HELP,
version = "0.0.0", // placeholder — overridden by clap_command() with DOMAIN_STATUS_VERSION
long_version = "0.0.0", // placeholder — overridden by clap_command() with DOMAIN_STATUS_VERSION
subcommand_required = true,
arg_required_else_help = true
)]
pub enum CliCommand {
#[command(name = "scan")]
Scan(ScanCommand),
#[command(name = "export")]
Export(ExportCommand),
#[command(name = "summary")]
Summary(SummaryCommand),
}
#[derive(Debug, Parser, Clone)]
#[command(after_help = concat!(
"Everyday flags: -h. All flags: --help. Docs: docs/CLI.md\n\n",
"Scan only hosts you are authorized to scan."
))]
pub struct ScanCommand {
#[arg(value_parser, help_heading = "Scan")]
pub file: PathBuf,
#[arg(
long,
value_parser,
default_value = "./domain_status.db",
env = "DOMAIN_STATUS_DB_PATH",
help_heading = "Scan"
)]
pub db_path: PathBuf,
#[arg(
long,
default_value_t = 10,
env = "DOMAIN_STATUS_TIMEOUT_SECONDS",
help_heading = "Scan"
)]
pub timeout_seconds: u64,
#[arg(
long,
default_value_t = 30,
env = "DOMAIN_STATUS_MAX_CONCURRENCY",
help_heading = "Scan"
)]
pub max_concurrency: usize,
#[arg(
long,
default_value_t = 15,
env = "DOMAIN_STATUS_RATE_LIMIT_RPS",
help_heading = "Scan"
)]
pub rate_limit_rps: u32,
#[arg(long, conflicts_with = "enable_whois", help_heading = "Enrichments")]
pub no_whois: bool,
#[arg(long, env = "DOMAIN_STATUS_GEOIP", help_heading = "Enrichments")]
pub geoip: Option<String>,
#[arg(
long,
env = "DOMAIN_STATUS_SCAN_EXTERNAL_SCRIPTS",
help_heading = "Enrichments"
)]
pub scan_external_scripts: bool,
#[arg(
long,
value_enum,
default_value_t = FailOn::Never,
env = "DOMAIN_STATUS_FAIL_ON",
help_heading = "CI / logging"
)]
pub fail_on: FailOn,
#[command(flatten, next_help_heading = "CI / logging")]
pub verbosity: clap_verbosity_flag::Verbosity<clap_verbosity_flag::InfoLevel>,
#[arg(
long,
value_enum,
default_value_t = LogLevel::Info,
env = "DOMAIN_STATUS_LOG_LEVEL",
hide_short_help = true,
help_heading = "CI / logging"
)]
pub log_level: LogLevel,
#[arg(
long,
value_enum,
default_value_t = LogFormat::Plain,
env = "DOMAIN_STATUS_LOG_FORMAT",
hide_short_help = true,
help_heading = "CI / logging"
)]
pub log_format: LogFormat,
#[arg(
long,
default_value = "domain_status.log",
env = "DOMAIN_STATUS_LOG_FILE",
hide_short_help = true,
help_heading = "CI / logging"
)]
pub log_file: PathBuf,
#[arg(
long,
env = "DOMAIN_STATUS_NO_PROGRESS",
hide_short_help = true,
help_heading = "CI / logging"
)]
pub no_progress: bool,
#[arg(
long,
default_value_t = 10,
value_parser = clap::value_parser!(u8).range(0..=100),
requires_if("pct>", "fail_on"),
env = "DOMAIN_STATUS_FAIL_ON_PCT_THRESHOLD",
hide_short_help = true,
help_heading = "CI / logging"
)]
pub fail_on_pct_threshold: u8,
#[arg(
long,
value_parser,
env = "DOMAIN_STATUS_CONFIG_FILE",
hide_short_help = true,
help_heading = "Advanced"
)]
pub config: Option<PathBuf>,
#[arg(
long,
default_value = DEFAULT_USER_AGENT,
env = "DOMAIN_STATUS_USER_AGENT",
hide_short_help = true,
help_heading = "Advanced"
)]
pub user_agent: String,
#[arg(
long,
env = "DOMAIN_STATUS_FINGERPRINTS",
hide_short_help = true,
help_heading = "Advanced"
)]
pub fingerprints: Option<String>,
#[arg(
long,
env = "DOMAIN_STATUS_ALLOW_DEGRADED_FINGERPRINTS",
hide_short_help = true,
help_heading = "Advanced"
)]
pub allow_degraded_fingerprints: bool,
#[arg(
long,
env = "DOMAIN_STATUS_STATUS_PORT",
hide_short_help = true,
help_heading = "Advanced"
)]
pub status_port: Option<u16>,
#[arg(
long,
value_parser,
env = "DOMAIN_STATUS_CACHE_DIR",
hide_short_help = true,
help_heading = "Advanced"
)]
pub cache_dir: Option<PathBuf>,
#[arg(
long,
default_value_t = 10,
env = "DOMAIN_STATUS_DRAIN_TIMEOUT_SECS",
hide_short_help = true,
help_heading = "Advanced"
)]
pub drain_timeout_secs: u64,
#[arg(
long,
env = "DOMAIN_STATUS_ENABLE_WHOIS",
default_value_t = true,
hide = true
)]
pub enable_whois: bool,
}
#[derive(Debug, Parser, Clone)]
pub struct ExportCommand {
#[arg(
long,
value_parser,
default_value = "./domain_status.db",
env = "DOMAIN_STATUS_DB_PATH"
)]
pub db_path: PathBuf,
#[arg(long, value_enum, default_value = "csv")]
pub format: ExportFormat,
#[arg(long)]
pub output: Option<String>,
#[arg(long)]
pub run_id: Option<String>,
#[arg(long)]
pub domain: Option<String>,
#[arg(long)]
pub status: Option<u16>,
#[arg(long)]
pub since: Option<i64>,
#[arg(long, default_value_t = false)]
pub include_implied_tech: bool,
}
#[derive(Debug, Parser, Clone)]
pub struct SummaryCommand {
#[arg(
long,
value_parser,
default_value = "./domain_status.db",
env = "DOMAIN_STATUS_DB_PATH"
)]
pub db_path: PathBuf,
#[arg(long)]
pub run_id: Option<String>,
#[arg(long, default_value_t = 15)]
pub top: usize,
}
#[derive(Clone, Debug, Default, clap::ValueEnum, PartialEq, Eq)]
#[non_exhaustive]
pub enum FailOn {
#[default]
Never,
#[value(name = "any-failure")]
AnyFailure,
#[value(name = "pct>")]
PctGreaterThan,
}
#[derive(Clone, Debug, Default, clap::ValueEnum, PartialEq, Eq)]
pub enum LogLevel {
Error,
Warn,
#[default]
Info,
Debug,
Trace,
}
#[derive(Copy, Clone, Debug, Default, clap::ValueEnum, PartialEq, Eq)]
#[non_exhaustive]
pub enum LogFormat {
#[default]
Plain,
Json,
}
#[derive(Debug, Clone, Default, clap::ValueEnum, PartialEq, Eq)]
pub enum ExportFormat {
#[default]
Csv,
Jsonl,
Parquet,
}
#[must_use]
pub fn clap_command(version: &'static str) -> clap::Command {
CliCommand::command().version(version).long_version(version)
}