Documentation
¶
Overview ¶
Package clitree is the CLI's command tree, shared by its shell completions and the control plane's web CLI console allowlist.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Tree = map[string]*Node{ "deploy": nil, "rollback": nil, "previews": {Subs: map[string]*Node{ "list": nil, "delete": nil, "teardown": nil, "extend": nil, "settings": nil, "enable": nil, "disable": nil, "sweep": nil, "limits": nil, "approve": nil, "pr-status": {Subs: map[string]*Node{"enable": nil, "disable": nil}}, }}, "apps": {Subs: map[string]*Node{ "freeze": {Subs: map[string]*Node{"set": nil, "show": nil, "clear": nil}}, "sbom": nil, "scan": {Subs: map[string]*Node{"enable": nil, "disable": nil, "status": nil, "run": nil, "gate": nil, "override": nil}}, "create": nil, "list": nil, "get": nil, "deploy": nil, "wait": nil, "deploy-compose": nil, "validate": nil, "deploy-spec": nil, "group": nil, "hook-runs": nil, "rollback": nil, "auto-rollback": {Subs: map[string]*Node{"enable": nil, "disable": nil, "status": nil}}, "sleep": {Subs: map[string]*Node{"enable": nil, "disable": nil, "status": nil, "wake": nil}}, "canary": {Subs: map[string]*Node{"start": nil, "status": nil, "weight": nil, "promote": nil, "abort": nil}}, "auto-update": {Subs: map[string]*Node{"enable": nil, "disable": nil, "status": nil, "check": nil, "webhook": nil}}, "auto-rollback-slo-burn": {Subs: map[string]*Node{"set": nil, "status": nil}}, "summary": nil, "changes": nil, "timeline": nil, "apply": nil, "domains": {Subs: map[string]*Node{"list": nil, "add": nil, "remove": nil}}, "streams": {Subs: map[string]*Node{"list": nil, "create": nil, "delete": nil}}, "restart": nil, "scale": nil, "stop": nil, "start": nil, "delete": nil, "status": nil, "diagnose": nil, "preflight": nil, "resource-recommendation": nil, "cost": nil, "deploys": {Subs: map[string]*Node{"list": nil, "show": nil, "wait": nil, "compare": nil, "logs": nil, "failed": nil, "steps": nil, "probes": nil, "cancel": nil, "rollback-to": nil, "gate": nil, "status": nil}}, "cancel-superseded": {Subs: map[string]*Node{"enable": nil, "disable": nil, "status": nil}}, "deploy-safety": {Subs: map[string]*Node{"show": nil, "set": nil, "targets": nil}}, "promote": nil, "network": nil, "logs": nil, "metrics": nil, "requests": nil, "resource-usage": nil, "overview": nil, "exec": nil, "exec-access": {Subs: map[string]*Node{"enable": nil, "disable": nil, "status": nil}}, "log-drain": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil}}, "scheduled-tasks": {Subs: map[string]*Node{"create": nil, "list": nil, "get": nil, "update": nil, "delete": nil, "run": nil}}, "alerts": {Subs: map[string]*Node{"list": nil, "create": nil, "update": nil, "delete": nil, "slo": nil}}, "deploy-notify-targets": {Subs: map[string]*Node{"list": nil, "create": nil, "delete": nil}}, "organizations": {Subs: map[string]*Node{ "create": nil, "list": nil, "get": nil, "delete": nil, "set-project": nil, "clear-project": nil, "env-get": nil, "env-set": nil, }}, "projects": {Subs: map[string]*Node{"create": nil, "list": nil, "get": nil, "delete": nil, "stop": nil, "start": nil, "restart": nil, "env-get": nil, "env-set": nil, "topology": nil}}, "environments": {Subs: map[string]*Node{"create": nil, "list": nil, "update": nil, "delete": nil, "env-get": nil, "env-set": nil, "env-diff": nil, "clone-preview": nil, "clone": nil}}, "set-environment": nil, "move-env": nil, "clear-environment": nil, "set-project": nil, "clear-project": nil, "set-node": nil, "clear-node": nil, "previews": {Subs: map[string]*Node{ "list": nil, "delete": nil, "teardown": nil, "extend": nil, "settings": nil, "enable": nil, "disable": nil, "sweep": nil, "limits": nil, "approve": nil, "pr-status": {Subs: map[string]*Node{"enable": nil, "disable": nil}}, }}, "env": {Subs: map[string]*Node{"import": nil, "export": nil, "get": nil, "diff": nil}}, "secrets": {Subs: map[string]*Node{"list": nil, "set": nil, "delete": nil, "lock": nil}}, "git-source": {Subs: map[string]*Node{"commits": nil, "get": nil, "show": nil, "detect": nil, "set": nil, "settings": nil, "rotate-secret": nil, "delete": nil}}, "webhook-deliveries": {Subs: map[string]*Node{"list": nil, "replay": nil}}, "bulk": nil, "clone": nil, "save-as-template": nil, "images": nil, "storage": {Subs: map[string]*Node{"set": nil, "clear": nil}}, "database": {Subs: map[string]*Node{"set": nil, "clear": nil}}, "connect": nil, "disconnect": nil, "connections": {Subs: map[string]*Node{"list": nil, "suggest": nil}}, "builds": {Subs: map[string]*Node{"trigger": nil}}, "moves": {Subs: map[string]*Node{"list": nil, "get": nil}}, "vault-env": {Subs: map[string]*Node{"set": nil, "clear": nil}}, "preview-env": {Subs: map[string]*Node{"set": nil, "clear": nil}}, "branch-env": {Subs: map[string]*Node{"list": nil, "set": nil, "clear": nil}}, "tag": nil, "untag": nil, "egress": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil}}, "build-cache": {Subs: map[string]*Node{"show": nil, "set": nil, "clear": nil, "remove": nil}}, "health": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil, "discover": nil}}, "health-score": nil, "volumes": {Subs: map[string]*Node{"get": nil, "attach": nil, "detach": nil}}, "integrations": {Subs: map[string]*Node{"catalog": nil, "list": nil, "add": nil, "remove": nil}}, }}, "jobs": {Subs: map[string]*Node{"list": nil, "get": nil, "create": nil, "update": nil, "run": nil, "history": nil, "logs": nil, "enable": nil, "disable": nil, "delete": nil}}, "functions": {Subs: map[string]*Node{"deploy": nil, "list": nil, "invoke": nil, "delete": nil}}, "models": {Subs: map[string]*Node{"list": nil, "get": nil, "deploy": nil, "logs": nil, "delete": nil, "restart": nil, "rotate-key": nil, "metrics": nil, "fit": nil, "residency": nil, "swap-group": nil, "wake": nil, "sleep": nil, "gpus": nil, "preflight": nil, "cache": {Subs: map[string]*Node{"list": nil, "prune": nil}}, "keys": {Subs: map[string]*Node{"list": nil, "create": nil, "revoke": nil, "rotate": nil}}, "usage": nil}}, "databases": {Subs: map[string]*Node{"move-env": nil, "connect": nil, "adopt": nil, "probe": nil, "create": nil, "list": nil, "get": nil, "status": nil, "delete": nil, "stop": nil, "start": nil, "resource-recommendation": nil, "metrics": nil, "logs": nil, "slow-queries": nil, "query": nil, "schema": nil, "set-project": nil, "clear-project": nil, "set-node": nil, "clear-node": nil, "set-resources": nil, "set-version": nil, "major-upgrade": nil, "major-upgrades": nil, "major-upgrade-rollback": nil, "major-upgrade-discard": nil, "upgrades": nil, "upgrade-policy": nil, "upgrade-now": nil, "public-access": {Subs: map[string]*Node{"set": nil, "clear": nil}}, "users": {Subs: map[string]*Node{"list": nil, "create": nil, "rotate": nil, "disable": nil, "enable": nil, "delete": nil}}, "access": {Subs: map[string]*Node{"temp": nil, "list": nil, "revoke": nil, "who": nil, "grant": nil}}, "network": {Subs: map[string]*Node{"show": nil, "allow": nil, "deny": nil, "make-private": nil, "scope": nil, "tls": nil}}}}, "auth": {Subs: map[string]*Node{"login": nil, "whoami": nil, "session-link": nil, "code": nil, "approve": nil, "deny": nil, "code-login": nil, "devices": {Subs: map[string]*Node{"revoke": nil}}, "2fa": {Subs: map[string]*Node{ "status": nil, "setup": nil, "enable": nil, "disable": nil, "recovery-codes": nil, }}}}, "profile": {Subs: map[string]*Node{"list": nil}}, "tokens": {Subs: map[string]*Node{"create": nil, "list": nil, "revoke": nil}}, "mobile": {Subs: map[string]*Node{"pair": nil, "devices": {Subs: map[string]*Node{"list": nil, "revoke": nil}}}}, "domains": {Subs: map[string]*Node{ "list": nil, "cloudflare-dns": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil}}, "route53-dns": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil}}, "basic-auth": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil}}, "auth-gate": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil, "log": nil, "revoke": nil}}, "maintenance": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil}}, "redirect": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil}}, "tls-cert": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil, "renew": nil}}, "check": nil, "doctor": nil, "summary": nil, "activity": nil, "certificates": nil, "connectivity": nil, "waf": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil}}, "error-pages": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil}}, "search-visibility": nil, "dns": {Subs: map[string]*Node{"list": nil, "add": nil, "remove": nil}}, "go-live": {Subs: map[string]*Node{"runs": nil, "undo": nil}}, "backfill-base-domain": nil, "headers": {Subs: map[string]*Node{"show": nil, "set": nil, "add": nil, "preset": nil, "clear": nil}}, "forwarders": {Subs: map[string]*Node{"show": nil, "set": nil, "add": nil, "remove": nil, "clear": nil}}, "geo": {Subs: map[string]*Node{"show": nil, "set": nil, "clear": nil, "lookup": nil}}, "cache": {Subs: map[string]*Node{"show": nil, "set": nil, "add": nil, "purge": nil, "stats": nil, "clear": nil}}, "redirects": {Subs: map[string]*Node{"show": nil, "force-https": nil, "canonical": nil, "alias": nil, "slash": nil, "lowercase": nil, "clear": nil}}, "ports": {Subs: map[string]*Node{"show": nil, "restrict": nil, "unrestrict": nil}}, "standalone": {Subs: map[string]*Node{"list": nil, "add": nil, "update": nil, "remove": nil}}, }}, "backups": {Subs: map[string]*Node{ "list": nil, "list-all": nil, "trigger": nil, "delete": nil, "download": nil, "restore": nil, "restore-as-new": nil, "restores": nil, "clone-restores": nil, "verify": nil, "verifications": nil, "health": nil, "protection": nil, "coverage": nil, "protect-all": nil, "orphans": {Subs: map[string]*Node{"list": nil, "reclaim": nil}}, "drill": {Subs: map[string]*Node{"run": nil, "list": nil, "show": nil}}, "volumes": {Subs: map[string]*Node{"list": nil, "policy": {Subs: map[string]*Node{"get": nil, "set": nil}}, "restore": nil}}, "schedule": {Subs: map[string]*Node{"set": nil, "clear": nil}}, }}, "pitr": {Subs: map[string]*Node{ "enable": nil, "disable": nil, "status": nil, "restore": nil, "restores": nil, "base-backups": {Subs: map[string]*Node{"list": nil, "trigger": nil}}, }}, "app-volume-backups": {Subs: map[string]*Node{ "list": nil, "trigger": nil, "delete": nil, "download": nil, "restore": nil, "restore-as-new": nil, "restores": nil, "clone-restores": nil, "verify": nil, "verifications": nil, "schedule": {Subs: map[string]*Node{"set": nil, "clear": nil}}, }}, "control-plane-backups": {Subs: map[string]*Node{"list": nil, "create": nil, "download": nil, "verify": nil, "delete": nil, "schedule": {Subs: map[string]*Node{"show": nil, "set": nil}}, "run-now": nil, "drill": {Subs: map[string]*Node{"run": nil, "status": nil}}, "escrow": nil, "keys": {Subs: map[string]*Node{"generate": nil}}, "help-dr": nil}}, "cloudflare-tunnel": {Subs: map[string]*Node{"get": nil, "set": nil, "disconnect": nil}}, "vault": {Subs: map[string]*Node{"get": nil, "set": nil, "disconnect": nil}}, "ai": {Subs: map[string]*Node{ "chat": nil, "sessions": {Subs: map[string]*Node{"list": nil, "get": nil, "delete": nil, "resolve": nil}}, }}, "alerts": {Subs: map[string]*Node{ "silences": {Subs: map[string]*Node{"list": nil, "create": nil, "delete": nil}}, "silence": nil, "maintenance": {Subs: map[string]*Node{"list": nil, "create": nil, "update": nil, "delete": nil}}, "history": nil, }}, "status-page": {Subs: map[string]*Node{ "get": nil, "set": nil, "preview": nil, "components": {Subs: map[string]*Node{"list": nil, "add": nil, "delete": nil}}, "incidents": {Subs: map[string]*Node{"list": nil, "create": nil, "update": nil, "delete": nil}}, }}, "channels": {Subs: map[string]*Node{"list": nil, "create": nil, "update": nil, "delete": nil, "test": nil, "deliveries": nil}}, "push-subscriptions": {Subs: map[string]*Node{"list": nil, "revoke": nil}}, "shared-env": {Subs: map[string]*Node{"list": nil, "set": nil, "delete": nil}}, "backup-targets": {Subs: map[string]*Node{"list": nil, "get": nil, "create": nil, "update": nil, "delete": nil, "test": nil}}, "firewall": {Subs: map[string]*Node{"list": nil, "allow": nil, "deny": nil, "delete": nil, "exposure": nil, "restrict": nil, "unrestrict": nil}}, "security": {Subs: map[string]*Node{"posture": nil, "sessions": {Subs: map[string]*Node{"list": nil, "revoke": nil, "revoke-others": nil}}, "policy": {Subs: map[string]*Node{"get": nil, "set": nil}}}}, "storage": {Subs: map[string]*Node{"providers": nil, "list": nil, "add": nil, "test": nil, "delete": nil}}, "logs": {Subs: map[string]*Node{"archive": {Subs: map[string]*Node{"set": nil, "status": nil, "remove": nil}}, "dump": nil, "ls": nil, "fetch": nil, "query": nil, "search": nil, "failure": nil, "signatures": nil, "alert-from": nil, "saved": {Subs: map[string]*Node{"list": nil, "create": nil, "run": nil, "delete": nil}}}}, "metrics": {Subs: map[string]*Node{"query": nil, "top": nil, "investigate": nil}}, "registry-credentials": {Subs: map[string]*Node{"list": nil, "get": nil, "create": nil, "update": nil, "delete": nil, "test": nil, "repositories": nil, "tags": nil}}, "network-shares": {Subs: map[string]*Node{"list": nil, "get": nil, "create": nil, "update": nil, "delete": nil, "test": nil}}, "registry": {Subs: map[string]*Node{"status": nil, "enable": nil, "disable": nil, "repositories": nil, "tags": nil}}, "flags": {Subs: map[string]*Node{"create": nil, "list": nil, "get": nil, "set": nil, "delete": nil}}, "pipelines": {Subs: map[string]*Node{"list": nil, "validate": nil, "save": nil, "delete": nil, "run": nil, "runs": nil, "logs": nil, "cancel": nil, "approve": nil, "sync": nil, "triggers": nil, "oidc": nil}}, "preview": {Subs: map[string]*Node{"status": nil, "enable": nil, "disable": nil, "capture": nil, "prune": nil}}, "environments": {Subs: map[string]*Node{"list": nil, "create": nil, "update": nil, "delete": nil}}, "deployments": {Subs: map[string]*Node{"list": nil, "watch": nil, "summary": nil}}, "lb": {Subs: map[string]*Node{"list": nil, "show": nil, "set": nil, "clear": nil, "status": nil, "check": nil, "history": nil, "upstream": nil, "export": nil, "import": nil}}, "tags": {Subs: map[string]*Node{"list": nil, "create": nil, "delete": nil, "apps": nil}}, "nodes": {Subs: map[string]*Node{ "list": nil, "get": nil, "delete": nil, "join-token": nil, "cordon": nil, "uncordon": nil, "drain": nil, "workloads": nil, "health": nil, "patch-status": nil, "events": nil, "metrics": nil, "resource-usage": nil, "capacity-forecast": nil, "add": nil, "move": nil, "moves": nil, "drains": nil, "labels": nil, "placement": nil, "connectivity": nil, "mesh": nil, "rotate-key": nil, "rejoin-mesh": nil, "reenroll-token": nil, "revoke-cert": nil, "providers": {Subs: map[string]*Node{"list": nil, "set-credential": nil}}, "provision": nil, "provisions": {Subs: map[string]*Node{"list": nil, "show": nil}}, "ssh-provision": nil, "ssh-provisions": {Subs: map[string]*Node{"list": nil, "show": nil}}, "topology": nil, "traffic": nil, }}, "status": nil, "version": nil, "changelog": nil, "upgrade": {Subs: map[string]*Node{"schedule": {Subs: map[string]*Node{"show": nil, "cancel": nil}}, "auto": {Subs: map[string]*Node{"get": nil, "set": nil}}, "backup-now": nil}}, "readiness": nil, "ai-control": {Subs: map[string]*Node{"status": nil, "set": nil, "revoke-agents": nil}}, "network": {Subs: map[string]*Node{"mesh": {Subs: map[string]*Node{"status": nil, "enable": nil, "disable": nil}}}}, "docker-guard": {Subs: map[string]*Node{"status": nil, "set": nil}}, "audit-log": nil, "audit-purge": nil, "attention": nil, "tui": nil, "advisor": {Subs: map[string]*Node{"findings": nil, "summary": nil, "apply": nil, "dismiss": nil, "snooze": nil, "restore": nil, "enable": nil, "disable": nil}}, "usage": {Subs: map[string]*Node{"report": nil, "settings": {Subs: map[string]*Node{"set": nil}}, "budgets": {Subs: map[string]*Node{"set": nil, "delete": nil}}}}, "doctor": nil, "setup": {Subs: map[string]*Node{"status": nil, "next": nil, "skip": nil, "undo": nil, "reset": nil}}, "proxy": {Subs: map[string]*Node{"setup": nil, "status": nil, "apply": nil, "verify": nil, "disable": nil}}, "auth-engine": {Subs: map[string]*Node{"status": nil}}, "api-docs": nil, "deploy-link": nil, "init": nil, "containers": {Subs: map[string]*Node{"list": nil, "stop": nil, "remove": nil, "claim": nil, "orphans": nil, "reap": nil}}, "system": {Subs: map[string]*Node{"address": nil, "restart": {Subs: map[string]*Node{"status": nil}}}}, "system-prune": nil, "volumes-orphaned": nil, "volumes-orphaned-cleanup": nil, "users": {Subs: map[string]*Node{"list": nil, "create": nil, "set-abilities": nil, "delete": nil, "roles": nil, "role": {Subs: map[string]*Node{"set": nil}}, "grants": {Subs: map[string]*Node{"get": nil, "set": nil}}}}, "roles": {Subs: map[string]*Node{"list": nil, "create": nil, "update": nil, "delete": nil}}, "invites": {Subs: map[string]*Node{"create": nil, "list": nil, "revoke": nil}}, "teams": {Subs: map[string]*Node{"list": nil, "create": nil, "show": nil, "rename": nil, "delete": nil, "use": nil, "roles": nil, "transfer": nil, "events": nil, "members": {Subs: map[string]*Node{"list": nil, "set-role": nil, "remove": nil, "leave": nil}}, "invites": {Subs: map[string]*Node{"list": nil, "create": nil, "revoke": nil, "accept": nil}}}}, "members": {Subs: map[string]*Node{"list": nil, "set-role": nil, "remove": nil, "leave": nil}}, "dns": {Subs: map[string]*Node{ "zones": {Subs: map[string]*Node{"list": nil, "create": nil, "delete": nil, "nameservers": nil, "verify": nil}}, "records": {Subs: map[string]*Node{"list": nil, "add": nil, "update": nil, "delete": nil, "import": nil, "export": nil, "template": nil}}, "check": nil, "health-checks": {Subs: map[string]*Node{"list": nil, "create": nil, "delete": nil}}, }}, "iam": {Subs: map[string]*Node{ "policies": {Subs: map[string]*Node{ "create": nil, "list": nil, "get": nil, "update": nil, "delete": nil, "attach": nil, "detach": nil, "attachments": nil, }}, "templates": {Subs: map[string]*Node{"list": nil, "apply": nil}}, "simulate": nil, "effective": nil, "analyze": nil, }}, "secrets": {Subs: map[string]*Node{"generate-master-key": nil, "rotate-master-key": nil, "binding-status": nil, "rebind": nil}}, "migrate": {Subs: map[string]*Node{"coolify": nil, "dokploy": nil, "caprover": nil, "server": nil, "db-copy": nil, "db-status": nil, "volumes": nil, "cutover": nil}}, "apply": nil, "diff": nil, "export": {Subs: map[string]*Node{"destinations": {Subs: map[string]*Node{"list": nil, "create": nil, "test": nil, "status": nil, "enable": nil, "disable": nil, "delete": nil}}, "audit": nil}}, "import": {Subs: map[string]*Node{"platform": {Subs: map[string]*Node{"coolify": nil, "dokploy": nil, "caprover": nil}}, "cutover": {Subs: map[string]*Node{"plan": nil, "run": nil, "status": nil, "rollback": nil, "confirm-dns": nil}}}}, "completion": {Subs: map[string]*Node{"bash": nil, "zsh": nil, "fish": nil}}, "settings": {Subs: map[string]*Node{ "oauth": {Subs: map[string]*Node{"list": nil, "set": nil}}, "email": {Subs: map[string]*Node{"get": nil, "set": nil}}, "ingress": {Subs: map[string]*Node{"get": nil, "set": nil, "https": {Subs: map[string]*Node{"status": nil, "enable": nil}}}}, "dashboard-url": {Subs: map[string]*Node{"get": nil, "set": nil}}, "ai-assistant": {Subs: map[string]*Node{"get": nil, "set": nil, "clear": nil}}, "updates": {Subs: map[string]*Node{"get": nil, "set": nil}}, "deploy-freeze": {Subs: map[string]*Node{"show": nil, "set": nil, "clear": nil}}, "domain-automation": {Subs: map[string]*Node{"get": nil, "set": nil}}, }}, "git-providers": nil, "github-app": {Subs: map[string]*Node{"status": nil, "disconnect": nil, "repos": nil, "branches": nil, "use-as-source": nil, "register-url": nil, "installations": {Subs: map[string]*Node{ "list": nil, "add": nil, "remove": nil, }}}}, "gitlab-app": {Subs: map[string]*Node{"status": nil, "disconnect": nil, "projects": nil, "branches": nil, "use-as-source": nil}}, "bitbucket-app": {Subs: map[string]*Node{"status": nil, "disconnect": nil, "repos": nil, "branches": nil, "use-as-source": nil}}, "gitea-app": {Subs: map[string]*Node{"status": nil, "disconnect": nil, "repos": nil, "branches": nil, "use-as-source": nil}}, "templates": {Subs: map[string]*Node{"list": nil, "get": nil, "deploy": nil, "install": nil, "delete": nil}}, "compose": {Subs: map[string]*Node{"deploy": nil, "preview": nil, "status": nil, "revisions": nil, "logs": nil, "redeploy": nil, "rollback": nil, "down": nil}}, "static-sites": {Subs: map[string]*Node{"list": nil}}, "deploy-approvals": {Subs: map[string]*Node{"list": nil, "get": nil, "approve": nil, "reject": nil}}, "build": {Subs: map[string]*Node{"detect": nil, "branches": nil}}, }
Tree mirrors every CLI dispatch switch; the CLI's drift test keeps them in sync.
Functions ¶
This section is empty.
Types ¶
Click to show internal directories.
Click to hide internal directories.