id = "stu"
name = "stu"
homepage = "https://lusingander.github.io/stu/"
description = "TUI explorer application for Amazon S3 (AWS S3)."
executables = ["stu"]

[dotfiles]

# The upstream documentation says STU reads config.toml from $STU_ROOT_DIR,
# defaulting to ~/.stu when that variable is unset.
# https://docs.rs/crate/stu/latest/source/README.md (Config)
paths = ["~/.stu/config.toml"]
secret = []

[commands]
format = 1
label = "Browse S3"
description = "Open the S3 terminal UI on an AWS profile, region or S3-compatible endpoint, optionally jumping to a bucket and prefix."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = true }

[[commands.source]]
id = "help"
kind = "help"
url = "https://github.com/lusingander/stu#usage"
revision = "2026-10-27"
evidence = """
  -r, --region <REGION>     AWS region
  -e, --endpoint-url <URL>  AWS endpoint url
  -p, --profile <NAME>      AWS profile name
  -b, --bucket <NAME>       Target bucket name
  -P, --prefix <PREFIX>     Prefix for object keys
      --path-style <TYPE>   Path style type for object paths [default: auto] [possible values: auto, always, never]
      --no-sign-request     Disable request signing
"""

[[commands.field]]
id = "profile"
label = "AWS profile"
type = "string"
option = ["--profile", "-p"]
sources = ["help"]

[[commands.field]]
id = "region"
label = "AWS region"
type = "string"
option = ["--region", "-r"]
sources = ["help"]

[[commands.field]]
id = "endpoint_url"
label = "Endpoint URL"
description = "For S3-compatible services such as MinIO or R2."
type = "url"
option = ["--endpoint-url", "-e"]
sources = ["help"]

[[commands.field]]
id = "bucket"
label = "Bucket"
type = "string"
option = ["--bucket", "-b"]
sources = ["help"]

[[commands.field]]
id = "prefix"
label = "Key prefix"
type = "string"
option = ["--prefix", "-P"]
sources = ["help"]

[[commands.field]]
id = "path_style"
label = "Path style"
type = "enum"
option = ["--path-style"]
choices = [
  { value = "auto", label = "Auto" },
  { value = "always", label = "Always" },
  { value = "never", label = "Never" },
]
sources = ["help"]

[[commands.field]]
id = "no_sign_request"
label = "Do not sign requests"
description = "For public buckets."
type = "boolean"
option = ["--no-sign-request"]
sources = ["help"]

[[commands.task]]
id = "open-bucket"
label = "Open a bucket"
fields = ["profile", "bucket", "prefix"]
required = ["bucket"]

[[commands.task]]
id = "custom-endpoint"
label = "S3-compatible endpoint"
fields = ["endpoint_url", "region", "path_style", "profile"]
required = ["endpoint_url"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["profile", "region", "bucket", "prefix"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["endpoint_url", "path_style", "no_sign_request"]