id = "traceroute"
name = "traceroute"
description = "Prints the route IP packets take to a network host."
executables = ["traceroute"]

[commands]
format = 1
label = "Trace route to host"
description = "Show the hops packets take to a host. Only common probe options are included."
quality = "ai-draft"
base = "fig:traceroute"
parser = { end_of_options = "--", interleave = "permute", long_equals = false, short_attached = true, short_bundles = true }

[[commands.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/traceroute.ts"
license = "MIT"

[[commands.field]]
id = "numeric"
label = "Numeric addresses"
description = "Skip the reverse DNS lookup for each hop."
type = "boolean"
option = ["-n"]
sources = ["fig"]

[[commands.field]]
id = "icmp"
label = "Use ICMP ECHO"
type = "boolean"
option = ["-I"]
sources = ["fig"]

[[commands.field]]
id = "max_ttl"
label = "Max hops"
type = "integer"
option = ["-m"]
sources = ["fig"]

[[commands.field]]
id = "first_ttl"
label = "First TTL"
type = "integer"
option = ["-f"]
sources = ["fig"]

[[commands.field]]
id = "queries"
label = "Probes per hop"
type = "integer"
option = ["-q"]
sources = ["fig"]

[[commands.field]]
id = "wait"
label = "Wait per probe (seconds)"
type = "integer"
option = ["-w"]
sources = ["fig"]

[[commands.field]]
id = "port"
label = "Base port"
type = "integer"
option = ["-p"]
sources = ["fig"]

[[commands.field]]
id = "source_addr"
label = "Source address"
type = "string"
option = ["-s"]
sources = ["fig"]

[[commands.field]]
id = "as_lookup"
label = "AS number lookups"
type = "boolean"
option = ["-a"]
sources = ["fig"]

[[commands.field]]
id = "summary"
label = "Unanswered summary"
type = "boolean"
option = ["-S"]
sources = ["fig"]

[[commands.field]]
id = "host"
label = "Host"
type = "string"
position = 0
sources = ["fig"]

[[commands.task]]
id = "trace"
label = "Trace a host"
fields = ["host", "numeric"]
required = ["host"]

[[commands.task]]
id = "icmp-trace"
label = "Trace with ICMP"
set = { icmp = [true], numeric = [true] }
fields = ["host", "icmp", "numeric", "max_ttl"]
required = ["host"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["host", "numeric", "icmp", "max_ttl"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["first_ttl", "queries", "wait", "port", "source_addr", "as_lookup", "summary"]