id       = "tio"
name     = "tio"
homepage = "https://github.com/tio/tio"
description = "A serial device I/O tool."
executables   = ["tio"]

[dotfiles]

# tio's official README lists the XDG config, ~/.config/tio/config, and the
# legacy ~/.tioconfig locations in its lookup order. Arbitrary includes and
# explicitly selected files are not fixed user paths.
# https://github.com/tio/tio#33-configuration-file
paths = ["[configHome]/tio/config", "~/.tioconfig"]
exclude = []
secret = []
side_effect = false

[commands]
format = 1
label = "Connect to a serial device"
description = "Open a serial TTY with the usual line settings. Mappings, scripting, sockets and key bindings are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = true }

[[commands.source]]
id = "man"
kind = "manual"
url = "https://github.com/tio/tio/blob/master/man/tio.1.in"
revision = "master 2026-10"
evidence = """
tio [<options>] <tty-device|profile|tid>
-b, --baudrate <bps>    Set baud rate [bps] (default: 115200).
-d, --databits 5 | 6 | 7 | 8    Set data bits (default: 8).
-f, --flow hard | soft | none    Set flow control (default: none).
-s, --stopbits 1 | 2    Set stop bits (default: 1).
-p, --parity odd | even | none | mark | space    Set parity (default: none).
-o, --output-delay <ms>
-e, --local-echo    Enable local echo.
-t, --timestamp    Enable line timestamp.
-l, --list    List available targets (serial devices, TIDs, configuration profiles).
-L, --log    Enable log to file.
--log-file <filename>    Set log filename.
-n, --no-reconnect
"""

[[commands.field]]
id = "target"
label = "Device, profile or TID"
description = "For example /dev/ttyUSB0 or /dev/cu.usbserial-0001."
type = "string"
position = 0
sources = ["man"]

[[commands.field]]
id = "baudrate"
label = "Baud rate"
type = "integer"
option = ["--baudrate", "-b"]
observed_default = "115200"
sources = ["man"]

[[commands.field]]
id = "databits"
label = "Data bits"
type = "enum"
option = ["--databits", "-d"]
choices = [{ value = "5", label = "5" }, { value = "6", label = "6" }, { value = "7", label = "7" }, { value = "8", label = "8" }]
sources = ["man"]

[[commands.field]]
id = "flow"
label = "Flow control"
type = "enum"
option = ["--flow", "-f"]
choices = [{ value = "hard", label = "Hardware" }, { value = "soft", label = "Software" }, { value = "none", label = "None" }]
sources = ["man"]

[[commands.field]]
id = "stopbits"
label = "Stop bits"
type = "enum"
option = ["--stopbits", "-s"]
choices = [{ value = "1", label = "1" }, { value = "2", label = "2" }]
sources = ["man"]

[[commands.field]]
id = "parity"
label = "Parity"
type = "enum"
option = ["--parity", "-p"]
choices = [{ value = "odd", label = "Odd" }, { value = "even", label = "Even" }, { value = "none", label = "None" }, { value = "mark", label = "Mark" }, { value = "space", label = "Space" }]
sources = ["man"]

[[commands.field]]
id = "local_echo"
label = "Local echo"
type = "boolean"
option = ["--local-echo", "-e"]
sources = ["man"]

[[commands.field]]
id = "timestamp"
label = "Line timestamps"
type = "boolean"
option = ["--timestamp", "-t"]
sources = ["man"]

[[commands.field]]
id = "log"
label = "Log to file"
type = "boolean"
option = ["--log", "-L"]
sources = ["man"]

[[commands.field]]
id = "log_file"
label = "Log file name"
type = "path"
path = { kind = "file", role = "output" }
option = ["--log-file"]
effect = "overwrite"
sources = ["man"]

[[commands.field]]
id = "no_reconnect"
label = "Do not reconnect"
type = "boolean"
option = ["--no-reconnect", "-n"]
sources = ["man"]

[[commands.field]]
id = "list"
label = "List available targets"
type = "boolean"
option = ["--list", "-l"]
sources = ["man"]

[[commands.task]]
id = "connect"
label = "Connect"
fields = ["target", "baudrate", "databits", "parity", "stopbits", "flow"]
required = ["target"]

[[commands.task]]
id = "list"
label = "List targets"
fields = ["list"]
required = ["list"]
set = { list = [true] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["target", "baudrate", "databits", "parity", "stopbits", "flow", "list"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["local_echo", "timestamp", "log", "log_file", "no_reconnect"]