id       = "zrok"
name     = "zrok"
homepage = "https://zrok.io/"
description = "A secure sharing platform for exposing local services and files."
executables   = ["zrok", "zrok2"]

[dotfiles]

# Official zrok release notes document the v1 environment directory ~/.zrok and
# the v2 directory ~/.zrok2; environments.json contains the enabled identity
# and account token. Both are retained as secret subtrees so either installed
# major version is restored without exposing credentials.
# https://github.com/openziti/zrok/blob/main/CHANGELOG.md#v200
# https://github.com/openziti/zrok/blob/main/CHANGELOG.md#v043
paths = []
exclude = []
secret = ["~/.zrok/", "~/.zrok2/"]
side_effect = false

[commands]
format = 1
label = "zrok"
description = "Share a local service or folder through zrok. Only the options shown in the project README are covered."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = false, short_attached = false, short_bundles = true }

[[commands.subcommand]]
path = ["share", "public"]
label = "Share publicly"

[[commands.subcommand.source]]
id = "readme"
kind = "manual"
url = "https://github.com/openziti/zrok/blob/main/README.md"
evidence = """
zrok share public localhost:8080
zrok share public --backend-mode drive ~/Documents
zrok share public -b drive
"""

[[commands.subcommand.field]]
id = "backend_mode"
label = "Backend mode"
type = "string"
option = ["--backend-mode", "-b"]
suggestions = [{ value = "drive", label = "Drive (share a folder)" }]
sources = ["readme"]

[[commands.subcommand.field]]
id = "target"
label = "Target (host:port or folder)"
type = "string"
position = 0
sources = ["readme"]

[[commands.subcommand.task]]
id = "web"
label = "Share a local web service"
fields = ["target"]
required = ["target"]

[[commands.subcommand.task]]
id = "drive"
label = "Share a folder as a drive"
fields = ["backend_mode", "target"]
required = ["backend_mode", "target"]
set = { backend_mode = ["drive"] }

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["target", "backend_mode"]