id          = "coder"
name        = "Coder"
homepage    = "https://coder.com"
description = "A tool for provisioning self-hosted development environments with Terraform."
executables      = ["coder"]

[dotfiles]

# Coder's --global-config uses the platform-native application-data directory
# (~/Library/Application Support/coderv2 on macOS, ~/.config/coderv2 on Linux,
# and %APPDATA%\\coderv2 on Windows). The CLI writes the deployment URL there;
# the login docs and source document the file-backed session alongside it:
# https://coder.com/docs/reference/cli/login
# https://github.com/coder/coder/blob/main/cli/sessionstore/sessionstore.go
paths   = ["[appData]/coderv2/url"]
secret  = ["[appData]/coderv2/session"]
exclude = []

[commands]
format = 1
label = "Coder workspaces"
description = "Create a workspace or open an SSH session into one. Parameter files, ephemeral parameters, org and auth options are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.subcommand]]
path = ["create"]
label = "Create a workspace"

[[commands.subcommand.source]]
id = "docs"
kind = "manual"
url = "https://github.com/coder/coder/blob/main/docs/reference/cli/create.md"
revision = "main 2026-10"
evidence = """
coder create [flags] [workspace]
### -t, --template
### --template-version
### --preset
### --stop-after
### --no-wait
### -y, --yes
### --parameter
"""

[[commands.subcommand.field]]
id = "workspace"
label = "Workspace name"
type = "string"
position = 0
sources = ["docs"]

[[commands.subcommand.field]]
id = "template"
label = "Template"
type = "string"
option = ["--template", "-t"]
sources = ["docs"]

[[commands.subcommand.field]]
id = "template_version"
label = "Template version"
type = "string"
option = ["--template-version"]
sources = ["docs"]

[[commands.subcommand.field]]
id = "preset"
label = "Preset"
type = "string"
option = ["--preset"]
sources = ["docs"]

[[commands.subcommand.field]]
id = "parameter"
label = "Parameters (name=value)"
type = "string"
option = ["--parameter"]
multiple = true
sources = ["docs"]

[[commands.subcommand.field]]
id = "stop_after"
label = "Stop after (duration)"
type = "string"
option = ["--stop-after"]
sources = ["docs"]

[[commands.subcommand.field]]
id = "no_wait"
label = "Do not wait for startup"
type = "boolean"
option = ["--no-wait"]
sources = ["docs"]

[[commands.subcommand.field]]
id = "yes"
label = "Skip confirmations"
type = "boolean"
option = ["--yes", "-y"]
sources = ["docs"]

[[commands.subcommand.task]]
id = "create"
label = "Create from template"
fields = ["workspace", "template", "parameter", "preset"]
required = ["template"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["workspace", "template", "template_version", "preset", "parameter"]

[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["stop_after", "no_wait", "yes"]

[[commands.subcommand]]
path = ["ssh"]
label = "SSH into a workspace"

[[commands.subcommand.source]]
id = "docs"
kind = "manual"
url = "https://github.com/coder/coder/blob/main/docs/reference/cli/ssh.md"
revision = "main 2026-10"
evidence = """
coder ssh [flags] <workspace> [command]
### -t, --tty
### -A, --forward-agent
### -R, --remote-forward
### -e, --env
### --wait
### --no-wait
"""

[[commands.subcommand.field]]
id = "workspace"
label = "Workspace"
type = "string"
position = 0
sources = ["docs"]

[[commands.subcommand.field]]
id = "command"
label = "Remote command"
type = "string"
position = 1
sources = ["docs"]

[[commands.subcommand.field]]
id = "forward_agent"
label = "Forward SSH agent"
type = "boolean"
option = ["--forward-agent", "-A"]
sources = ["docs"]

[[commands.subcommand.field]]
id = "tty"
label = "Force a TTY"
type = "boolean"
option = ["--tty", "-t"]
sources = ["docs"]

[[commands.subcommand.field]]
id = "env"
label = "Environment variables"
type = "string"
option = ["--env", "-e"]
multiple = true
sources = ["docs"]

[[commands.subcommand.field]]
id = "remote_forward"
label = "Remote port forward"
type = "string"
option = ["--remote-forward", "-R"]
multiple = true
sources = ["docs"]

[[commands.subcommand.task]]
id = "ssh"
label = "Open a shell"
fields = ["workspace", "forward_agent"]
required = ["workspace"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["workspace", "command", "forward_agent", "tty"]

[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["env", "remote_forward"]