From a599dd59e145c991190fedf681e077004cfd5218 Mon Sep 17 00:00:00 2001 From: Max Hsu Date: Thu, 16 Jul 2026 21:13:15 +0800 Subject: [PATCH] feat(talosctl): add completion spec for Talos Linux CLI Static spec generated by walking talosctl v1.13.6's Cobra command tree (106 nodes, 49 top-level commands) via its help output, then curated: - talosctl_builtin_completion generator delegates dynamic completions (config contexts, node services, resource types, --nodes/--endpoints/ --context values) to the CLI's hidden Cobra __complete command, mirroring oc_builtin_completion in oc.rs - filepaths/folders templates on path-like flags (--talosconfig, --file, --*-path, --*-dir, ...) - hand-fixed usage strings the tokenizer can't parse (copy's '-|', service's nested optional action) Closes warpdotdev/warp#12693 Co-Authored-By: Claude Opus 4.8 (1M context) Claude-Session: https://claude.ai/code/session_01XWwajmLbgJbK6JBCY8nKfk --- command-signatures/json/talosctl.json | 6369 +++++++++++++++++ command-signatures/src/generators/mod.rs | 2 + command-signatures/src/generators/talosctl.rs | 87 + 3 files changed, 6458 insertions(+) create mode 100644 command-signatures/json/talosctl.json create mode 100644 command-signatures/src/generators/talosctl.rs diff --git a/command-signatures/json/talosctl.json b/command-signatures/json/talosctl.json new file mode 100644 index 00000000..89e19459 --- /dev/null +++ b/command-signatures/json/talosctl.json @@ -0,0 +1,6369 @@ +{ + "name": "talosctl", + "description": "A CLI for out-of-band management of Kubernetes nodes created by Talos", + "subcommands": [ + { + "name": "apply-config", + "description": "Apply a new configuration to a node", + "options": [ + { + "name": "--cert-fingerprint", + "description": "list of server certificate fingeprints to accept (defaults to no check)", + "args": { + "name": "strings" + } + }, + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": [ + "--config-patch", + "-p" + ], + "description": "the list of config patches to apply to the local config file before sending it to the node", + "args": { + "name": "stringArray" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--dry-run", + "description": "check how the config change will be applied in dry-run mode" + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--file", + "-f" + ], + "description": "the filename of the updated configuration", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for apply-config" + }, + { + "name": [ + "--insecure", + "-i" + ], + "description": "apply the config using the insecure (encrypted with no auth) maintenance service" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--timeout", + "description": "the config will be rolled back after specified timeout (if try mode is selected)", + "args": { + "name": "duration" + } + } + ] + }, + { + "name": "bootstrap", + "description": "Bootstrap the etcd cluster on the specified node.", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for bootstrap" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--recover-from", + "description": "recover etcd cluster from the snapshot", + "args": { + "name": "string" + } + }, + { + "name": "--recover-skip-hash-check", + "description": "skip integrity check when recovering etcd (use when recovering from data directory copy)" + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "cgroups", + "description": "Retrieve cgroups usage information", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for cgroups" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--preset", + "description": "preset name (one of: [cpu cpuset io memory process psi swap])", + "args": { + "name": "string" + } + }, + { + "name": "--schema-file", + "description": "path to the columns schema file", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--skip-cri-resolve", + "description": "do not resolve cgroup names via a request to CRI" + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "config", + "description": "Manage the client configuration file (talosconfig)", + "subcommands": [ + { + "name": "add", + "description": "Add a new context", + "options": [ + { + "name": "--ca", + "description": "the path to the CA certificate", + "args": { + "name": "string" + } + }, + { + "name": "--crt", + "description": "the path to the certificate", + "args": { + "name": "string" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for add" + }, + { + "name": "--key", + "description": "the path to the key", + "args": { + "name": "string" + } + } + ], + "args": { + "name": "context" + } + }, + { + "name": "context", + "description": "Set the current context", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for context" + } + ], + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "contexts", + "description": "List defined contexts", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for contexts" + } + ] + }, + { + "name": "endpoint", + "description": "Set the endpoint(s) for the current context", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for endpoint" + } + ], + "args": { + "name": "endpoint", + "isVariadic": true + } + }, + { + "name": "info", + "description": "Show information about the current context", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for info" + }, + { + "name": [ + "--output", + "-o" + ], + "description": "output format (json|yaml|text). Default text.", + "args": { + "name": "string" + } + } + ] + }, + { + "name": "merge", + "description": "Merge additional contexts from another client configuration file", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for merge" + } + ], + "args": { + "name": "from", + "template": "filepaths" + } + }, + { + "name": "new", + "description": "Generate a new client configuration file", + "options": [ + { + "name": "--crt-ttl", + "description": "certificate TTL", + "args": { + "name": "duration" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for new" + }, + { + "name": "--roles", + "description": "roles", + "args": { + "name": "strings" + } + } + ], + "args": { + "name": "path", + "isOptional": true + } + }, + { + "name": "node", + "description": "Set the node(s) for the current context", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for node" + } + ], + "args": { + "name": "endpoint", + "isVariadic": true + } + }, + { + "name": "remove", + "description": "Remove contexts", + "options": [ + { + "name": "--dry-run", + "description": "dry run" + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for remove" + }, + { + "name": [ + "--noconfirm", + "-y" + ], + "description": "do not ask for confirmation" + } + ], + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + } + ], + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for config" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "conformance", + "description": "Run conformance tests", + "subcommands": [ + { + "name": "kubernetes", + "description": "Run Kubernetes conformance tests", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for kubernetes" + }, + { + "name": "--mode", + "description": "conformance test mode: [fast, certified, network-policy]", + "args": { + "name": "string" + } + } + ] + } + ], + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for conformance" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "containers", + "description": "List containers", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for containers" + }, + { + "name": [ + "--kubernetes", + "-k" + ], + "description": "use the k8s.io containerd namespace" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "copy", + "description": "Copy data out from the node", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for copy" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ], + "args": [ + { + "name": "src-path", + "description": "Path on the node to copy from" + }, + { + "name": "local-path", + "description": "Local destination path, or - to write a tar archive to stdout", + "template": "filepaths", + "suggestions": [ + { + "name": "-", + "description": "Write a tar archive to stdout" + } + ] + } + ] + }, + { + "name": "dashboard", + "description": "Cluster dashboard with node overview, logs and real-time metrics", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for dashboard" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": [ + "--update-interval", + "-d" + ], + "description": "interval between updates", + "args": { + "name": "duration" + } + } + ] + }, + { + "name": "debug", + "description": "Run a debug container from an image archive or reference", + "options": [ + { + "name": "--args", + "description": "arguments to pass to the container", + "args": { + "name": "strings" + } + }, + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for debug" + }, + { + "name": "--namespace", + "description": "namespace to use: system (CRI containerd) or `inmem` for in-memory containerd instance", + "args": { + "name": "system" + } + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ], + "args": [ + { + "name": "image-tar-path|image ref" + }, + { + "name": "args", + "isOptional": true + } + ] + }, + { + "name": "dmesg", + "description": "Retrieve kernel logs", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--follow", + "-f" + ], + "description": "specify if the kernel log should be streamed" + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for dmesg" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--tail", + "description": "specify if only new messages should be sent (makes sense only when combined with --follow)" + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "edit", + "description": "Edit Talos node machine configuration with the default editor.", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--dry-run", + "description": "do not apply the change after editing and print the change summary instead" + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for edit" + }, + { + "name": "--namespace", + "description": "resource namespace", + "args": { + "name": "string" + } + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--timeout", + "description": "the config will be rolled back after specified timeout (if try mode is selected)", + "args": { + "name": "duration" + } + } + ], + "args": { + "name": "machineconfig", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "etcd", + "description": "Manage etcd", + "subcommands": [ + { + "name": "alarm", + "description": "Manage etcd alarms", + "subcommands": [ + { + "name": "disarm", + "description": "Disarm the etcd alarms for the node.", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for disarm" + } + ] + }, + { + "name": "list", + "description": "List the etcd alarms for the node.", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for list" + } + ] + } + ], + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for alarm" + } + ] + }, + { + "name": "defrag", + "description": "Defragment etcd database on the node", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for defrag" + } + ] + }, + { + "name": "downgrade", + "description": "Manage etcd storage system downgrades", + "subcommands": [ + { + "name": "cancel", + "description": "Cancel etcd storage system downgrade.", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for cancel" + } + ] + }, + { + "name": "enable", + "description": "Enable etcd storage system downgrade to the specified version.", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for enable" + } + ], + "args": { + "name": "version" + } + }, + { + "name": "validate", + "description": "Validate if the etcd storage system can be downgraded to the specified version.", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for validate" + } + ], + "args": { + "name": "version" + } + } + ], + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for downgrade" + } + ] + }, + { + "name": "leave", + "description": "Tell nodes to leave etcd cluster", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for leave" + } + ] + }, + { + "name": "members", + "description": "Get the list of etcd cluster members", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for members" + } + ] + }, + { + "name": "remove-member", + "description": "Remove the node from etcd cluster", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for remove-member" + } + ], + "args": { + "name": "member ID" + } + }, + { + "name": "snapshot", + "description": "Stream snapshot of the etcd node to the path.", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for snapshot" + } + ], + "args": { + "name": "path" + } + }, + { + "name": "status", + "description": "Get the status of etcd cluster member", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for status" + } + ] + } + ], + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for etcd" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "events", + "description": "Stream runtime events", + "options": [ + { + "name": "--actor-id", + "description": "filter events by the specified actor ID", + "args": { + "name": "string" + } + }, + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--duration", + "description": "show events for the past duration interval (one second resolution, default is to show no history)", + "args": { + "name": "duration" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for events" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--since", + "description": "show events after the specified event ID", + "args": { + "name": "string" + } + }, + { + "name": "--tail", + "description": "show specified number of past events (use -1 to show full history, default is to show no history)", + "args": { + "name": "int32" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "get", + "description": "Get a specific resource or list of resources (use 'talosctl get rd' to see all available resource types).", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for get" + }, + { + "name": [ + "--insecure", + "-i" + ], + "description": "get resources using the insecure (encrypted with no auth) maintenance service" + }, + { + "name": "--namespace", + "description": "resource namespace", + "args": { + "name": "string" + } + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--output", + "-o" + ], + "description": "output mode (json, table, yaml, jsonpath)", + "args": { + "name": "string" + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": [ + "--watch", + "-w" + ], + "description": "watch resource changes" + } + ], + "args": [ + { + "name": "type", + "generatorName": "talosctl_builtin_completion" + }, + { + "name": "id", + "isOptional": true + } + ] + }, + { + "name": "health", + "description": "Check cluster health", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--control-plane-nodes", + "description": "specify IPs of control plane nodes", + "args": { + "name": "strings" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for health" + }, + { + "name": "--init-node", + "description": "specify IPs of init node", + "args": { + "name": "string" + } + }, + { + "name": "--k8s-endpoint", + "description": "use endpoint instead of kubeconfig default", + "args": { + "name": "string" + } + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--run-e2e", + "description": "run Kubernetes e2e test" + }, + { + "name": "--server", + "description": "run server-side check" + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--wait-timeout", + "description": "timeout to wait for the cluster to be ready", + "args": { + "name": "duration" + } + }, + { + "name": "--worker-nodes", + "description": "specify IPs of worker nodes", + "args": { + "name": "strings" + } + } + ] + }, + { + "name": "image", + "description": "Manage container images", + "subcommands": [ + { + "name": "cache-create", + "description": "Create a cache of images in OCI format into a directory", + "options": [ + { + "name": "--cosign-signatures", + "description": "pull and cache cosign signatures for images" + }, + { + "name": "--force", + "description": "force overwrite of existing image cache" + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for cache-create" + }, + { + "name": "--image-cache-path", + "description": "directory to save the image cache in OCI format", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--image-layer-cache-path", + "description": "directory to save the image layer cache", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--images", + "description": "images to cache", + "args": { + "name": "strings" + } + }, + { + "name": "--insecure", + "description": "allow insecure registries" + }, + { + "name": "--layout", + "description": "Specifies the cache layout format: \"oci\" for an OCI image layout directory, or \"flat\" for a registry-like flat file structure", + "args": { + "name": "string" + } + }, + { + "name": "--platform", + "description": "platform(s) to cache (e.g. linux/amd64,linux/arm64), or \"all\" to cache every platform in the image index", + "args": { + "name": "strings" + } + } + ] + }, + { + "name": "cache-serve", + "description": "Serve an OCI image cache directory over HTTP(S) as a container registry", + "options": [ + { + "name": "--address", + "description": "address to serve the registry on", + "args": { + "name": "string" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for cache-serve" + }, + { + "name": "--image-cache-path", + "description": "directory to save the image cache in flat format", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--mirror", + "description": "list of registry mirrors to add to the Talos config patch", + "args": { + "name": "strings" + } + }, + { + "name": "--tls-cert-file", + "description": "TLS certificate file to use for serving", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--tls-key-file", + "description": "TLS key file to use for serving", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "k8s-bundle", + "description": "List the default Kubernetes images used by Talos", + "options": [ + { + "name": "--coredns-version", + "description": "CoreDNS semantic version", + "args": { + "name": "semver" + } + }, + { + "name": "--etcd-version", + "description": "ETCD semantic version", + "args": { + "name": "semver" + } + }, + { + "name": "--flannel-version", + "description": "Flannel CNI semantic version", + "args": { + "name": "semver" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for k8s-bundle" + }, + { + "name": "--k8s-version", + "description": "Kubernetes semantic version", + "args": { + "name": "semver" + } + }, + { + "name": "--kube-network-policies-version", + "description": "kube-network-policies semantic version", + "args": { + "name": "semver" + } + } + ] + }, + { + "name": "list", + "description": "List images in the machine's container runtime", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for list" + } + ] + }, + { + "name": "pull", + "description": "Pull an image into the machine's container runtime", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for pull" + } + ], + "args": { + "name": "image" + } + }, + { + "name": "remove", + "description": "Remove an image from the machine's container runtime", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for remove" + } + ], + "args": { + "name": "image" + } + }, + { + "name": "talos-bundle", + "description": "List the default system images and extensions used for Talos", + "options": [ + { + "name": "--extensions", + "description": "Include images that belong to Talos extensions" + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for talos-bundle" + }, + { + "name": "--overlays", + "description": "Include images that belong to Talos overlays" + } + ], + "args": { + "name": "talos-version", + "isOptional": true + } + } + ], + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for image" + }, + { + "name": "--namespace", + "description": "namespace to use: \"system\" (etcd and kubelet images), \"cri\" for all Kubernetes workloads, \"inmem\" for in-memory containerd instance", + "args": { + "name": "string" + } + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "inspect", + "description": "Inspect internals of Talos", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for inspect" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "kubeconfig", + "description": "Download the admin kubeconfig from the node", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--force", + "-f" + ], + "description": "Force overwrite of kubeconfig if already present, force overwrite on kubeconfig merge" + }, + { + "name": "--force-context-name", + "description": "Force context name for kubeconfig merge", + "args": { + "name": "string" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for kubeconfig" + }, + { + "name": [ + "--merge", + "-m" + ], + "description": "Merge with existing kubeconfig" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ], + "args": { + "name": "local-path", + "isOptional": true, + "template": "folders" + } + }, + { + "name": "list", + "description": "Retrieve a directory listing", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--depth", + "-d" + ], + "description": "maximum recursion depth", + "args": { + "name": "int32" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for list" + }, + { + "name": [ + "--humanize", + "-H" + ], + "description": "humanize size and time in the output" + }, + { + "name": [ + "--long", + "-l" + ], + "description": "display additional file details" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--recurse", + "-r" + ], + "description": "recurse into subdirectories" + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": [ + "--type", + "-t" + ], + "description": "filter by specified types: f\tregular file d\tdirectory l, L\tsymbolic link", + "args": { + "name": "strings" + } + } + ], + "args": { + "name": "path", + "isOptional": true + } + }, + { + "name": "logs", + "description": "Retrieve logs for a service", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--follow", + "-f" + ], + "description": "specify if the logs should be streamed" + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for logs" + }, + { + "name": [ + "--kubernetes", + "-k" + ], + "description": "use the k8s.io containerd namespace" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--tail", + "description": "lines of log file to display", + "args": { + "name": "int32" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ], + "args": { + "name": "service name", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "memory", + "description": "Show memory usage", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for memory" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": [ + "--verbose", + "-v" + ], + "description": "display extended memory statistics" + } + ] + }, + { + "name": "meta", + "description": "Write and delete keys in the META partition", + "subcommands": [ + { + "name": "delete", + "description": "Delete a key from the META partition.", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for delete" + } + ], + "args": { + "name": "key" + } + }, + { + "name": "write", + "description": "Write a key-value pair to the META partition.", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for write" + } + ], + "args": [ + { + "name": "key" + }, + { + "name": "value" + } + ] + } + ], + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for meta" + }, + { + "name": [ + "--insecure", + "-i" + ], + "description": "write|delete meta using the insecure (encrypted with no auth) maintenance service" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "mounts", + "description": "List mounts", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for mounts" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "netstat", + "description": "Show network connections and sockets", + "options": [ + { + "name": [ + "--all", + "-a" + ], + "description": "display all sockets states (default: connected)" + }, + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--extend", + "-x" + ], + "description": "show detailed socket information" + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for netstat" + }, + { + "name": [ + "--ipv4", + "-4" + ], + "description": "display only ipv4 sockets" + }, + { + "name": [ + "--ipv6", + "-6" + ], + "description": "display only ipv6 sockets" + }, + { + "name": [ + "--listening", + "-l" + ], + "description": "display listening server sockets" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--pods", + "-k" + ], + "description": "show sockets used by Kubernetes pods" + }, + { + "name": [ + "--programs", + "-p" + ], + "description": "show process using socket" + }, + { + "name": [ + "--raw", + "-w" + ], + "description": "display only RAW sockets" + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": [ + "--tcp", + "-t" + ], + "description": "display only TCP sockets" + }, + { + "name": [ + "--timers", + "-o" + ], + "description": "display timers" + }, + { + "name": [ + "--udp", + "-u" + ], + "description": "display only UDP sockets" + }, + { + "name": [ + "--udplite", + "-U" + ], + "description": "display only UDPLite sockets" + }, + { + "name": [ + "--verbose", + "-v" + ], + "description": "display sockets of all supported transport protocols" + } + ] + }, + { + "name": "patch", + "description": "Patch machine configuration of a Talos node with a local patch.", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--dry-run", + "description": "print the change summary and patch preview without applying the changes" + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for patch" + }, + { + "name": "--namespace", + "description": "resource namespace", + "args": { + "name": "string" + } + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--patch", + "-p" + ], + "description": "the patch to be applied to the resource file, use @file to read a patch from file.", + "args": { + "name": "stringArray" + } + }, + { + "name": "--patch-file", + "description": "a file containing a patch to be applied to the resource.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--timeout", + "description": "the config will be rolled back after specified timeout (if try mode is selected)", + "args": { + "name": "duration" + } + } + ], + "args": { + "name": "machineconfig", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "pcap", + "description": "Capture the network packets from the node.", + "options": [ + { + "name": "--bpf-filter", + "description": "bpf filter to apply, tcpdump -dd format", + "args": { + "name": "string" + } + }, + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--duration", + "description": "duration of the capture", + "args": { + "name": "duration" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for pcap" + }, + { + "name": [ + "--interface", + "-i" + ], + "description": "interface name to capture packets on", + "args": { + "name": "string" + } + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--output", + "-o" + ], + "description": "if not set, decode packets to stdout; if set write raw pcap data to a file, use '-' for stdout", + "args": { + "name": "string" + } + }, + { + "name": "--promiscuous", + "description": "put interface into promiscuous mode" + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "processes", + "description": "List running processes", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for processes" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": [ + "--sort", + "-s" + ], + "description": "Column to sort output by. [rss|cpu]", + "args": { + "name": "string" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "read", + "description": "Read a file on the machine", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for read" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ], + "args": { + "name": "path" + } + }, + { + "name": "reboot", + "description": "Reboot a node", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--debug", + "description": "debug operation from kernel logs. --wait is set to true when this flag is set" + }, + { + "name": "--drain", + "description": "drain the Kubernetes node before rebooting (cordon + evict pods)" + }, + { + "name": "--drain-timeout", + "description": "timeout for draining the Kubernetes node", + "args": { + "name": "duration" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for reboot" + }, + { + "name": [ + "--mode", + "-m" + ], + "description": "select the reboot mode during upgrade. Mode \"powercycle\" bypasses kexec. Values: [default force powercycle]", + "args": { + "name": "string" + } + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--progress", + "description": "output mode for upgrade progress. Values: [auto plain]", + "args": { + "name": "string" + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--timeout", + "description": "time to wait for the operation is complete if --debug or --wait is set", + "args": { + "name": "duration" + } + }, + { + "name": "--wait", + "description": "wait for the operation to complete, tracking its progress. always set to true when --debug is set" + } + ] + }, + { + "name": "reset", + "description": "Reset a node", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--debug", + "description": "debug operation from kernel logs. --wait is set to true when this flag is set" + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--graceful", + "description": "if true, attempt to cordon/drain node and leave etcd (if applicable)" + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for reset" + }, + { + "name": "--insecure", + "description": "reset using the insecure (encrypted with no auth) maintenance service" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--reboot", + "description": "if true, reboot the node after resetting instead of shutting down" + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--system-labels-to-wipe", + "description": "if set, just wipe selected system disk partitions by label but keep other partitions intact", + "args": { + "name": "strings" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--timeout", + "description": "time to wait for the operation is complete if --debug or --wait is set", + "args": { + "name": "duration" + } + }, + { + "name": "--user-disks-to-wipe", + "description": "if set, wipes defined devices in the list", + "args": { + "name": "strings" + } + }, + { + "name": "--wait", + "description": "wait for the operation to complete, tracking its progress. always set to true when --debug is set" + } + ] + }, + { + "name": "restart", + "description": "Restart a process", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for restart" + }, + { + "name": [ + "--kubernetes", + "-k" + ], + "description": "use the k8s.io containerd namespace" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ], + "args": { + "name": "id", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "rollback", + "description": "Rollback a node to the previous installation", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for rollback" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "rotate-ca", + "description": "Rotate cluster CAs (Talos and Kubernetes APIs).", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--control-plane-nodes", + "description": "specify IPs of control plane nodes", + "args": { + "name": "strings" + } + }, + { + "name": "--dry-run", + "description": "dry-run mode (no changes to the cluster)" + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for rotate-ca" + }, + { + "name": "--init-node", + "description": "specify IPs of init node", + "args": { + "name": "string" + } + }, + { + "name": "--k8s-endpoint", + "description": "use endpoint instead of kubeconfig default", + "args": { + "name": "string" + } + }, + { + "name": "--kubernetes", + "description": "rotate Kubernetes API CA" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--output", + "-o" + ], + "description": "path to the output new talosconfig", + "args": { + "name": "talosconfig" + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talos", + "description": "rotate Talos API CA" + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--with-docs", + "description": "patch all machine configs adding the documentation for each field" + }, + { + "name": "--with-examples", + "description": "patch all machine configs with the commented examples" + }, + { + "name": "--worker-nodes", + "description": "specify IPs of worker nodes", + "args": { + "name": "strings" + } + } + ] + }, + { + "name": "service", + "description": "Retrieve the state of a service (or all services), control service state", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for service" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ], + "args": [ + { + "name": "id", + "isOptional": true, + "generatorName": "talosctl_builtin_completion" + }, + { + "name": "action", + "isOptional": true, + "suggestions": [ + { + "name": "start", + "description": "Start the service" + }, + { + "name": "stop", + "description": "Stop the service" + }, + { + "name": "restart", + "description": "Restart the service" + }, + { + "name": "status", + "description": "Show service status" + } + ] + } + ] + }, + { + "name": "shutdown", + "description": "Shutdown a node", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--debug", + "description": "debug operation from kernel logs. --wait is set to true when this flag is set" + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--force", + "description": "if true, force a node to shutdown without a cordon/drain" + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for shutdown" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--timeout", + "description": "time to wait for the operation is complete if --debug or --wait is set", + "args": { + "name": "duration" + } + }, + { + "name": "--wait", + "description": "wait for the operation to complete, tracking its progress. always set to true when --debug is set" + } + ] + }, + { + "name": "stats", + "description": "Get container stats", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for stats" + }, + { + "name": [ + "--kubernetes", + "-k" + ], + "description": "use the k8s.io containerd namespace" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "support", + "description": "Dump debug information about the cluster", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for support" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--num-workers", + "-w" + ], + "description": "number of workers per node", + "args": { + "name": "int" + } + }, + { + "name": [ + "--output", + "-O" + ], + "description": "output file to write support archive to", + "args": { + "name": "string" + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": [ + "--verbose", + "-v" + ], + "description": "verbose output" + } + ] + }, + { + "name": "time", + "description": "Gets current server time", + "options": [ + { + "name": "--check", + "description": "checks server time against specified ntp server", + "args": { + "name": "string" + } + }, + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for time" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ], + "args": { + "name": "--check server", + "isOptional": true + } + }, + { + "name": "upgrade", + "description": "Upgrade Talos on the target node", + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--debug", + "description": "debug operation from kernel logs. --wait is set to true when this flag is set" + }, + { + "name": "--drain", + "description": "drain the Kubernetes node before rebooting (cordon + evict pods)" + }, + { + "name": "--drain-timeout", + "description": "timeout for draining the Kubernetes node", + "args": { + "name": "duration" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for upgrade" + }, + { + "name": [ + "--image", + "-i" + ], + "description": "the container image to use for performing the install", + "args": { + "name": "string" + } + }, + { + "name": "--legacy", + "description": "force use of legacy upgrade method" + }, + { + "name": "--namespace", + "description": "namespace to use: \"system\" (etcd and kubelet images), \"cri\" for all Kubernetes workloads, \"inmem\" for in-memory containerd instance", + "args": { + "name": "string" + } + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--progress", + "description": "output mode for upgrade progress. Values: [auto plain]", + "args": { + "name": "string" + } + }, + { + "name": [ + "--reboot-mode", + "-m" + ], + "description": "select the reboot mode during upgrade. Mode \"powercycle\" bypasses kexec. Values: [default force powercycle]", + "args": { + "name": "string" + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--timeout", + "description": "time to wait for the operation is complete if --debug or --wait is set", + "args": { + "name": "duration" + } + }, + { + "name": "--wait", + "description": "wait for the operation to complete, tracking its progress. always set to true when --debug is set" + } + ] + }, + { + "name": "upgrade-k8s", + "description": "Upgrade Kubernetes control plane in the Talos cluster.", + "options": [ + { + "name": "--apiserver-image", + "description": "kube-apiserver image to use", + "args": { + "name": "string" + } + }, + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": "--controller-manager-image", + "description": "kube-controller-manager image to use", + "args": { + "name": "string" + } + }, + { + "name": "--dry-run", + "description": "skip the actual upgrade and show the upgrade plan instead" + }, + { + "name": "--endpoint", + "description": "the cluster control plane endpoint", + "args": { + "name": "string" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--from", + "description": "the Kubernetes control plane version to upgrade from", + "args": { + "name": "string" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for upgrade-k8s" + }, + { + "name": "--kubelet-image", + "description": "kubelet image to use", + "args": { + "name": "string" + } + }, + { + "name": "--manifests-force", + "description": "whether to recreate objects that contain immutable field changes" + }, + { + "name": "--manifests-inventory-policy", + "description": "kubernetes SSA inventory policy (one of 'MustMatch', 'AdoptIfNoInventory' or 'AdoptAll')", + "args": { + "name": "string" + } + }, + { + "name": "--manifests-no-prune", + "description": "whether pruning of previously applied objects should happen after apply" + }, + { + "name": "--manifests-reconcile-timeout", + "description": "how long to wait for resources to be fully reconciled (set to zero to disable waiting)", + "args": { + "name": "duration" + } + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--pre-pull-images", + "description": "pre-pull images before upgrade" + }, + { + "name": "--proxy-image", + "description": "kube-proxy image to use", + "args": { + "name": "string" + } + }, + { + "name": "--scheduler-image", + "description": "kube-scheduler image to use", + "args": { + "name": "string" + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--to", + "description": "the Kubernetes control plane version to upgrade to", + "args": { + "name": "string" + } + }, + { + "name": "--upgrade-kubelet", + "description": "upgrade kubelet service" + }, + { + "name": "--with-docs", + "description": "patch all machine configs adding the documentation for each field" + }, + { + "name": "--with-examples", + "description": "patch all machine configs with the commented examples" + } + ] + }, + { + "name": "usage", + "description": "Retrieve a disk usage", + "options": [ + { + "name": [ + "--all", + "-a" + ], + "description": "write counts for all files, not just directories" + }, + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--depth", + "-d" + ], + "description": "maximum recursion depth", + "args": { + "name": "int32" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for usage" + }, + { + "name": [ + "--humanize", + "-H" + ], + "description": "humanize size and time in the output" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": [ + "--threshold", + "-t" + ], + "description": "threshold exclude entries smaller than SIZE if positive, or entries greater than SIZE if negative", + "args": { + "name": "int" + } + } + ], + "args": [ + { + "name": "path1", + "isOptional": true + }, + { + "name": "path2", + "isOptional": true + }, + { + "name": "", + "isVariadic": true + }, + { + "name": "pathN", + "isOptional": true + } + ] + }, + { + "name": "version", + "description": "Prints the version", + "options": [ + { + "name": "--client", + "description": "Print client version only" + }, + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for version" + }, + { + "name": [ + "--insecure", + "-i" + ], + "description": "use Talos maintenance mode API" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--short", + "description": "Print the short version" + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "wipe", + "description": "Wipe block device or volumes", + "subcommands": [ + { + "name": "disk", + "description": "Wipe a block device (disk or partition) which is not used as a volume", + "options": [ + { + "name": "--drop-partition", + "description": "drop partition after wipe (if applicable)" + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for disk" + }, + { + "name": [ + "--insecure", + "-i" + ], + "description": "use Talos maintenance mode API" + }, + { + "name": "--method", + "description": "wipe method to use [FAST ZEROES]", + "args": { + "name": "string" + } + } + ], + "args": { + "name": "device names", + "isVariadic": true + } + } + ], + "options": [ + { + "name": [ + "--cluster", + "-c" + ], + "description": "Cluster to connect to if a proxy endpoint is used.", + "args": { + "name": "string" + } + }, + { + "name": "--context", + "description": "Context to be used in command", + "args": { + "name": "context", + "generatorName": "talosctl_builtin_completion" + } + }, + { + "name": [ + "--endpoints", + "-e" + ], + "description": "override default endpoints in Talos configuration", + "args": { + "name": "endpoint", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for wipe" + }, + { + "name": [ + "--nodes", + "-n" + ], + "description": "target the specified nodes", + "args": { + "name": "node", + "generatorName": "talosctl_builtin_completion", + "isVariadic": true + } + }, + { + "name": "--siderov1-keys-dir", + "description": "The path to the SideroV1 auth PGP keys directory. Defaults to 'SIDEROV1_KEYS_DIR' env variable if set, otherwise '$HOME/.talos/keys'. Only valid for Contexts that use SideroV1 auth.", + "args": { + "name": "string", + "template": "folders" + } + }, + { + "name": "--talosconfig", + "description": "The path to the Talos configuration file. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "gen", + "description": "Generate CAs, certificates, and private keys", + "subcommands": [ + { + "name": "ca", + "description": "Generates a self-signed X.509 certificate authority", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for ca" + }, + { + "name": "--hours", + "description": "the hours from now on which the certificate validity period ends", + "args": { + "name": "int" + } + }, + { + "name": "--organization", + "description": "X.509 distinguished name for the Organization", + "args": { + "name": "string" + } + }, + { + "name": "--rsa", + "description": "generate in RSA format" + } + ] + }, + { + "name": "config", + "description": "Generates a set of configuration files for Talos cluster", + "options": [ + { + "name": "--additional-sans", + "description": "additional Subject-Alt-Names for the APIServer certificate", + "args": { + "name": "strings" + } + }, + { + "name": "--config-patch", + "description": "patch generated machineconfigs (applied to all node types), use @file to read a patch from file", + "args": { + "name": "stringArray" + } + }, + { + "name": "--config-patch-control-plane", + "description": "patch generated machineconfigs (applied to 'init' and 'controlplane' types)", + "args": { + "name": "stringArray" + } + }, + { + "name": "--config-patch-worker", + "description": "patch generated machineconfigs (applied to 'worker' type)", + "args": { + "name": "stringArray" + } + }, + { + "name": "--dns-domain", + "description": "the dns domain to use for cluster", + "args": { + "name": "string" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for config" + }, + { + "name": "--install-disk", + "description": "the disk to install to", + "args": { + "name": "string" + } + }, + { + "name": "--install-image", + "description": "the image used to perform an installation", + "args": { + "name": "string" + } + }, + { + "name": "--kubernetes-version", + "description": "desired kubernetes version to run", + "args": { + "name": "string" + } + }, + { + "name": [ + "--output", + "-o" + ], + "description": "destination to output generated files. when multiple output types are specified, it must be a directory. for a single output type, it must either be a file path, or \"-\" for stdout", + "args": { + "name": "string" + } + }, + { + "name": [ + "--output-types", + "-t" + ], + "description": "types of outputs to be generated. valid types are: [\"controlplane\" \"worker\" \"talosconfig\"]", + "args": { + "name": "strings" + } + }, + { + "name": "--registry-mirror", + "description": "list of registry mirrors to use in format: =", + "args": { + "name": "strings" + } + }, + { + "name": "--talos-version", + "description": "the desired Talos version to generate config for (backwards compatibility, e.g. v0.8)", + "args": { + "name": "string" + } + }, + { + "name": "--version", + "description": "the desired machine config version to generate", + "args": { + "name": "string" + } + }, + { + "name": "--with-cluster-discovery", + "description": "enable cluster discovery feature" + }, + { + "name": "--with-docs", + "description": "renders all machine configs adding the documentation for each field" + }, + { + "name": "--with-examples", + "description": "renders all machine configs with the commented examples" + }, + { + "name": "--with-kubespan", + "description": "enable KubeSpan feature" + }, + { + "name": "--with-secrets", + "description": "use a secrets file generated using 'gen secrets'", + "args": { + "name": "string" + } + } + ], + "args": [ + { + "name": "cluster name" + }, + { + "name": "cluster endpoint" + } + ] + }, + { + "name": "crt", + "description": "Generates an X.509 Ed25519 certificate", + "options": [ + { + "name": "--ca", + "description": "path to the PEM encoded CERTIFICATE", + "args": { + "name": "string" + } + }, + { + "name": "--csr", + "description": "path to the PEM encoded CERTIFICATE REQUEST", + "args": { + "name": "string" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for crt" + }, + { + "name": "--hours", + "description": "the hours from now on which the certificate validity period ends", + "args": { + "name": "int" + } + }, + { + "name": "--name", + "description": "the basename of the generated file", + "args": { + "name": "string" + } + } + ] + }, + { + "name": "csr", + "description": "Generates a CSR using an Ed25519 private key", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for csr" + }, + { + "name": "--ip", + "description": "generate the certificate for this IP address", + "args": { + "name": "string" + } + }, + { + "name": "--key", + "description": "path to the PEM encoded EC or RSA PRIVATE KEY", + "args": { + "name": "string" + } + }, + { + "name": "--roles", + "description": "roles", + "args": { + "name": "strings" + } + } + ] + }, + { + "name": "key", + "description": "Generates an Ed25519 private key", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for key" + }, + { + "name": "--name", + "description": "the basename of the generated file", + "args": { + "name": "string" + } + } + ] + }, + { + "name": "keypair", + "description": "Generates an X.509 Ed25519 key pair", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for keypair" + }, + { + "name": "--ip", + "description": "generate the certificate for this IP address", + "args": { + "name": "string" + } + }, + { + "name": "--organization", + "description": "X.509 distinguished name for the Organization", + "args": { + "name": "string" + } + } + ] + }, + { + "name": "secrets", + "description": "Generates a secrets bundle file which can later be used to generate a config", + "options": [ + { + "name": "--from-controlplane-config", + "description": "use the provided controlplane Talos machine configuration as input", + "args": { + "name": "string" + } + }, + { + "name": [ + "--from-kubernetes-pki", + "-p" + ], + "description": "use a Kubernetes PKI directory (e.g. /etc/kubernetes/pki) as input", + "args": { + "name": "string" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for secrets" + }, + { + "name": [ + "--kubernetes-bootstrap-token", + "-t" + ], + "description": "use the provided bootstrap token as input", + "args": { + "name": "string" + } + }, + { + "name": [ + "--output-file", + "-o" + ], + "description": "path of the output file, or \"-\" for stdout", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--talos-version", + "description": "the desired Talos version to generate secrets bundle for (backwards compatibility, e.g. v0.8)", + "args": { + "name": "string" + } + } + ] + }, + { + "name": "secureboot", + "description": "Generates secrets for the SecureBoot process", + "subcommands": [ + { + "name": "database", + "description": "Generates a UEFI database to enroll the signing certificate", + "options": [ + { + "name": "--enrolled-certificate", + "description": "path to the certificate to enroll", + "args": { + "name": "string" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for database" + }, + { + "name": "--include-well-known-uefi-certs", + "description": "include well-known UEFI (Microsoft) certificates in the database" + }, + { + "name": "--signing-certificate", + "description": "path to the certificate used to sign the database", + "args": { + "name": "string" + } + }, + { + "name": "--signing-key", + "description": "path to the key used to sign the database", + "args": { + "name": "string" + } + } + ] + }, + { + "name": "pcr", + "description": "Generates a key which is used to sign TPM PCR values", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for pcr" + } + ] + }, + { + "name": "uki", + "description": "Generates a certificate which is used to sign boot assets (UKI)", + "options": [ + { + "name": "--common-name", + "description": "common name for the certificate", + "args": { + "name": "string" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for uki" + } + ] + } + ], + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for secureboot" + }, + { + "name": [ + "--output", + "-o" + ], + "description": "path to the directory storing the generated files", + "args": { + "name": "string" + } + } + ] + } + ], + "options": [ + { + "name": [ + "--force", + "-f" + ], + "description": "will overwrite existing files" + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for gen" + } + ] + }, + { + "name": "inject", + "description": "Inject Talos API resources into Kubernetes manifests", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for inject" + } + ] + }, + { + "name": "machineconfig", + "description": "Machine config related commands", + "subcommands": [ + { + "name": "gen", + "description": "Generates a set of configuration files for Talos cluster", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for gen" + } + ], + "args": [ + { + "name": "cluster name" + }, + { + "name": "cluster endpoint" + } + ] + }, + { + "name": "patch", + "description": "Patch a machine config", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for patch" + }, + { + "name": [ + "--output", + "-o" + ], + "description": "output destination. if not specified, output will be printed to stdout", + "args": { + "name": "string" + } + }, + { + "name": [ + "--patch", + "-p" + ], + "description": "patch generated machineconfigs (applied to all node types), use @file to read a patch from file", + "args": { + "name": "stringArray" + } + } + ], + "args": { + "name": "machineconfig-file" + } + } + ], + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for machineconfig" + } + ] + }, + { + "name": "validate", + "description": "Validate config", + "options": [ + { + "name": [ + "--config", + "-c" + ], + "description": "the path of the config file", + "args": { + "name": "string" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for validate" + }, + { + "name": [ + "--mode", + "-m" + ], + "description": "the mode to validate the config for (valid values are metal, cloud, and container)", + "args": { + "name": "string" + } + }, + { + "name": "--strict", + "description": "treat validation warnings as errors" + } + ] + }, + { + "name": "cluster", + "description": "A collection of commands for managing local docker-based or QEMU-based clusters", + "subcommands": [ + { + "name": "create", + "description": "Create a local Talos cluster.", + "subcommands": [ + { + "name": "dev", + "description": "Creates a local QEMU-based cluster for Talos development.", + "options": [ + { + "name": "--arch", + "description": "cluster architecture", + "args": { + "name": "string" + } + }, + { + "name": "--cidr", + "description": "CIDR of the cluster network (IPv4, ULA network for IPv6 is derived in automated way)", + "args": { + "name": "string" + } + }, + { + "name": "--config-patch", + "description": "patch generated machineconfigs (applied to all node types), use @file to read a patch from file", + "args": { + "name": "stringArray" + } + }, + { + "name": "--config-patch-control-plane", + "description": "patch generated machineconfigs (applied to 'controlplane' type)", + "args": { + "name": "stringArray" + } + }, + { + "name": "--config-patch-worker", + "description": "patch generated machineconfigs (applied to 'worker' type)", + "args": { + "name": "stringArray" + } + }, + { + "name": "--control-plane-port", + "description": "control plane port (load balancer and local API port)", + "args": { + "name": "int" + } + }, + { + "name": "--controlplanes", + "description": "the number of controlplanes to create", + "args": { + "name": "int" + } + }, + { + "name": "--cpus", + "description": "the share of CPUs as fraction for each control plane/VM", + "args": { + "name": "string" + } + }, + { + "name": "--cpus-workers", + "description": "the share of CPUs as fraction for each worker/VM", + "args": { + "name": "string" + } + }, + { + "name": "--custom-cni-url", + "description": "install custom CNI from the URL (Talos cluster)", + "args": { + "name": "string" + } + }, + { + "name": "--disable-dhcp-hostname", + "description": "skip announcing hostname via DHCP" + }, + { + "name": "--disk", + "description": "default limit on disk size in MB (each VM)", + "args": { + "name": "int" + } + }, + { + "name": "--disk-block-size", + "description": "disk block size", + "args": { + "name": "uint" + } + }, + { + "name": "--disk-encryption-key-types", + "description": "encryption key types to use for disk encryption (uuid, kms)", + "args": { + "name": "stringArray" + } + }, + { + "name": "--disk-image-path", + "description": "disk image to use", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--disk-preallocate", + "description": "whether disk space should be preallocated" + }, + { + "name": "--dns-domain", + "description": "the dns domain to use for cluster", + "args": { + "name": "string" + } + }, + { + "name": "--encrypt-ephemeral", + "description": "enable ephemeral partition encryption" + }, + { + "name": "--encrypt-state", + "description": "enable state partition encryption" + }, + { + "name": "--encrypt-user-volumes", + "description": "enable ephemeral partition encryption" + }, + { + "name": "--endpoint", + "description": "use endpoint instead of provider defaults", + "args": { + "name": "string" + } + }, + { + "name": "--extra-boot-kernel-args", + "description": "add extra kernel args to the initial boot from vmlinuz and initramfs", + "args": { + "name": "string" + } + }, + { + "name": "--extra-disks", + "description": "number of extra disks to create for each worker VM", + "args": { + "name": "int" + } + }, + { + "name": "--extra-disks-drivers", + "description": "driver for each extra disk (virtio, ide, ahci, scsi, nvme, megaraid)", + "args": { + "name": "strings" + } + }, + { + "name": "--extra-disks-serials", + "description": "serials for each extra disk", + "args": { + "name": "strings" + } + }, + { + "name": "--extra-disks-size", + "description": "default limit on disk size in MB (each VM)", + "args": { + "name": "int" + } + }, + { + "name": "--extra-disks-tags", + "description": "tags for each extra disk (only used by virtiofs)", + "args": { + "name": "strings" + } + }, + { + "name": "--extra-uefi-search-paths", + "description": "additional search paths for UEFI firmware (only applies when UEFI is enabled)", + "args": { + "name": "strings", + "template": "filepaths" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for dev" + }, + { + "name": "--image-cache-path", + "description": "path to image cache", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--image-cache-port", + "description": "port on which to serve image cache", + "args": { + "name": "uint16" + } + }, + { + "name": "--image-cache-tls-cert-file", + "description": "path to image cache TLS cert", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--image-cache-tls-key-file", + "description": "path to image cache TLS key", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--init-node-as-endpoint", + "description": "use init node as endpoint instead of any load balancer endpoint" + }, + { + "name": "--initrd-path", + "description": "initramfs image to use", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--install-image", + "description": "the installer image to use", + "args": { + "name": "string" + } + }, + { + "name": "--ipv4", + "description": "enable IPv4 network in the cluster" + }, + { + "name": "--ipv6", + "description": "enable IPv6 network in the cluster" + }, + { + "name": "--ipxe-boot-script", + "description": "iPXE boot script (URL) to use", + "args": { + "name": "string" + } + }, + { + "name": "--iso-path", + "description": "the ISO path to use for the initial boot", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--kubeprism-port", + "description": "KubePrism port (set to 0 to disable)", + "args": { + "name": "int" + } + }, + { + "name": "--kubernetes-version", + "description": "desired kubernetes version to run", + "args": { + "name": "string" + } + }, + { + "name": "--memory", + "description": "the limit on memory usage for each control plane/VM", + "args": { + "name": "string(mb,gb)" + } + }, + { + "name": "--memory-workers", + "description": "the limit on memory usage for each worker/VM", + "args": { + "name": "string(mb,gb)" + } + }, + { + "name": "--mtu", + "description": "MTU of the cluster network", + "args": { + "name": "int" + } + }, + { + "name": "--nameservers", + "description": "list of nameservers to use", + "args": { + "name": "strings" + } + }, + { + "name": "--omni-api-endpoint", + "description": "the Omni API endpoint (must include a scheme, a hostname and a join token, e.g. 'https://siderolink.omni.example?jointoken=foobar')", + "args": { + "name": "string" + } + }, + { + "name": "--registry-insecure-skip-verify", + "description": "list of registry hostnames to skip TLS verification for", + "args": { + "name": "strings" + } + }, + { + "name": "--registry-mirror", + "description": "list of registry mirrors to use in format: =", + "args": { + "name": "strings" + } + }, + { + "name": "--skip-injecting-config", + "description": "skip injecting config from embedded metadata server, write config files to current directory" + }, + { + "name": "--skip-injecting-extra-cmdline", + "description": "skip injecting extra kernel cmdline parameters via EFI vars through bootloader" + }, + { + "name": "--skip-k8s-node-readiness-check", + "description": "skip k8s node readiness checks" + }, + { + "name": "--skip-kubeconfig", + "description": "skip merging kubeconfig from the created cluster" + }, + { + "name": "--talos-version", + "description": "the desired Talos version to generate config for", + "args": { + "name": "string" + } + }, + { + "name": "--talosconfig", + "description": "The location to save the generated Talos configuration file to. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--uki-path", + "description": "the UKI image path to use for the initial boot", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--usb-path", + "description": "the USB stick image path to use for the initial boot", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--use-vip", + "description": "use a virtual IP for the controlplane endpoint instead of the loadbalancer" + }, + { + "name": "--user-volumes", + "description": "list of user volumes to create for each VM in format: :::", + "args": { + "name": "strings" + } + }, + { + "name": "--vmlinuz-path", + "description": "the compressed kernel image to use", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--wait", + "description": "wait for the cluster to be ready before returning" + }, + { + "name": "--wait-timeout", + "description": "timeout to wait for the cluster to be ready", + "args": { + "name": "duration" + } + }, + { + "name": "--wireguard-cidr", + "description": "CIDR of the wireguard network", + "args": { + "name": "string" + } + }, + { + "name": "--with-apply-config", + "description": "enable apply config when the VM is starting in maintenance mode" + }, + { + "name": "--with-bootloader", + "description": "enable bootloader to load kernel and initramfs from disk image after install" + }, + { + "name": "--with-cluster-discovery", + "description": "enable cluster discovery" + }, + { + "name": "--with-debug", + "description": "enable debug in Talos config to send service logs to the console" + }, + { + "name": "--with-firewall", + "description": "inject firewall rules into the cluster, value is default policy - accept/block", + "args": { + "name": "string" + } + }, + { + "name": "--with-init-node", + "description": "create the cluster with an init node" + }, + { + "name": "--with-iommu", + "description": "enable IOMMU support, this also add a new PCI root port and an interface attached to it" + }, + { + "name": "--with-json-logs", + "description": "enable JSON logs receiver and configure Talos to send logs there" + }, + { + "name": "--with-kubespan", + "description": "enable KubeSpan system" + }, + { + "name": "--with-siderolink", + "description": "enables the use of siderolink agent as configuration apply mechanism. true or `wireguard` enables the agent, `tunnel` enables the agent with grpc tunneling", + "args": { + "name": "true" + } + }, + { + "name": "--with-tpm1_2", + "description": "enable TPM 1.2 emulation support using swtpm" + }, + { + "name": "--with-tpm2", + "description": "enable TPM 2.0 emulation support using swtpm" + }, + { + "name": "--with-uefi", + "description": "enable UEFI on x86_64 architecture" + }, + { + "name": "--with-uuid-hostnames", + "description": "use machine UUIDs as default hostnames" + }, + { + "name": "--workers", + "description": "the number of workers to create", + "args": { + "name": "int" + } + } + ] + }, + { + "name": "docker", + "description": "Create a local Docker based kubernetes cluster", + "options": [ + { + "name": "--config-patch", + "description": "patch generated machineconfigs (applied to all node types), use @file to read a patch from file", + "args": { + "name": "stringArray" + } + }, + { + "name": "--config-patch-controlplanes", + "description": "patch generated machineconfigs (applied to 'controlplane' type)", + "args": { + "name": "stringArray" + } + }, + { + "name": "--config-patch-workers", + "description": "patch generated machineconfigs (applied to 'worker' type)", + "args": { + "name": "stringArray" + } + }, + { + "name": "--cpus-controlplanes", + "description": "the share of CPUs as fraction for each control plane/VM", + "args": { + "name": "string" + } + }, + { + "name": "--cpus-workers", + "description": "the share of CPUs as fraction for each worker/VM", + "args": { + "name": "string" + } + }, + { + "name": [ + "--exposed-ports", + "-p" + ], + "description": "comma-separated list of ports/protocols to expose on init node. Ex -p :/", + "args": { + "name": "string" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for docker" + }, + { + "name": "--host-ip", + "description": "Host IP to forward exposed ports to", + "args": { + "name": "string" + } + }, + { + "name": "--image", + "description": "the talos image to run", + "args": { + "name": "string" + } + }, + { + "name": "--kubernetes-version", + "description": "desired kubernetes version to run", + "args": { + "name": "string" + } + }, + { + "name": "--memory-controlplanes", + "description": "the limit on memory usage for each control plane/VM", + "args": { + "name": "string(mb,gb)" + } + }, + { + "name": "--memory-workers", + "description": "the limit on memory usage for each worker/VM", + "args": { + "name": "string(mb,gb)" + } + }, + { + "name": "--mount", + "description": "attach a mount to the container (docker --mount syntax)", + "args": { + "name": "mount" + } + }, + { + "name": "--subnet", + "description": "Docker network subnet CIDR", + "args": { + "name": "string" + } + }, + { + "name": "--talosconfig-destination", + "description": "The location to save the generated Talos configuration file to. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--workers", + "description": "the number of workers to create", + "args": { + "name": "int" + } + } + ] + }, + { + "name": "qemu", + "description": "Create a local QEMU based Talos cluster.", + "options": [ + { + "name": "--cidr", + "description": "CIDR of the cluster network", + "args": { + "name": "string" + } + }, + { + "name": "--config-patch", + "description": "patch generated machineconfigs (applied to all node types), use @file to read a patch from file", + "args": { + "name": "stringArray" + } + }, + { + "name": "--config-patch-controlplanes", + "description": "patch generated machineconfigs (applied to 'controlplane' type)", + "args": { + "name": "stringArray" + } + }, + { + "name": "--config-patch-workers", + "description": "patch generated machineconfigs (applied to 'worker' type)", + "args": { + "name": "stringArray" + } + }, + { + "name": "--controlplanes", + "description": "the number of controlplanes to create", + "args": { + "name": "int" + } + }, + { + "name": "--cpus-controlplanes", + "description": "the share of CPUs as fraction for each control plane/VM", + "args": { + "name": "string" + } + }, + { + "name": "--cpus-workers", + "description": "the share of CPUs as fraction for each worker/VM", + "args": { + "name": "string" + } + }, + { + "name": "--disks", + "description": "list of disks to create in format \":\" (disks after the first one are added only to worker machines)", + "args": { + "name": "disks" + } + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for qemu" + }, + { + "name": "--image-factory-auth", + "description": "username:password for authenticating with the Image Factory", + "args": { + "name": "string" + } + }, + { + "name": "--image-factory-url", + "description": "Image Factory url", + "args": { + "name": "string" + } + }, + { + "name": "--kubernetes-version", + "description": "desired kubernetes version to run", + "args": { + "name": "string" + } + }, + { + "name": "--memory-controlplanes", + "description": "the limit on memory usage for each control plane/VM", + "args": { + "name": "string(mb,gb)" + } + }, + { + "name": "--memory-workers", + "description": "the limit on memory usage for each worker/VM", + "args": { + "name": "string(mb,gb)" + } + }, + { + "name": "--omni-api-endpoint", + "description": "the Omni API endpoint (must include a scheme, a hostname and a join token, e.g. 'https://siderolink.omni.example?jointoken=foobar')", + "args": { + "name": "string" + } + }, + { + "name": "--presets", + "description": "list of presets to apply", + "args": { + "name": "strings" + } + }, + { + "name": "--schematic-id", + "description": "Image Factory schematic id (defaults to an empty schematic)", + "args": { + "name": "string" + } + }, + { + "name": "--talos-version", + "description": "the desired talos version", + "args": { + "name": "string" + } + }, + { + "name": "--talosconfig-destination", + "description": "The location to save the generated Talos configuration file to. Defaults to 'TALOSCONFIG' env variable if set, otherwise '$HOME/.talos/config' and '/var/run/secrets/talos.dev/config' in order.", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--workers", + "description": "the number of workers to create", + "args": { + "name": "int" + } + } + ] + } + ], + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for create" + } + ] + }, + { + "name": "destroy", + "description": "Destroys a local Talos kubernetes cluster", + "options": [ + { + "name": [ + "--force", + "-f" + ], + "description": "force deletion of cluster directory if there were errors" + }, + { + "name": [ + "--help", + "-h" + ], + "description": "help for destroy" + }, + { + "name": "--save-cluster-logs-archive-path", + "description": "save cluster logs archive to the specified file on destroy", + "args": { + "name": "string", + "template": "filepaths" + } + }, + { + "name": "--save-support-archive-path", + "description": "save support archive to the specified file on destroy", + "args": { + "name": "string", + "template": "filepaths" + } + } + ] + }, + { + "name": "show", + "description": "Shows info about a local provisioned kubernetes cluster", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for show" + }, + { + "name": "--provisioner", + "description": "cluster provisioner to use", + "args": { + "name": "string" + } + } + ] + } + ], + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for cluster" + }, + { + "name": "--name", + "description": "the name of the cluster", + "args": { + "name": "string" + } + }, + { + "name": "--state", + "description": "directory path to store cluster state", + "args": { + "name": "string" + } + } + ] + }, + { + "name": "completion", + "description": "Generate the autocompletion script for the specified shell", + "subcommands": [ + { + "name": "bash", + "description": "Generate the autocompletion script for bash", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for bash" + }, + { + "name": "--no-descriptions", + "description": "disable completion descriptions" + } + ] + }, + { + "name": "fish", + "description": "Generate the autocompletion script for fish", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for fish" + }, + { + "name": "--no-descriptions", + "description": "disable completion descriptions" + } + ] + }, + { + "name": "powershell", + "description": "Generate the autocompletion script for powershell", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for powershell" + }, + { + "name": "--no-descriptions", + "description": "disable completion descriptions" + } + ] + }, + { + "name": "zsh", + "description": "Generate the autocompletion script for zsh", + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for zsh" + }, + { + "name": "--no-descriptions", + "description": "disable completion descriptions" + } + ] + } + ], + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for completion" + } + ] + } + ], + "options": [ + { + "name": [ + "--help", + "-h" + ], + "description": "help for talosctl" + } + ] +} diff --git a/command-signatures/src/generators/mod.rs b/command-signatures/src/generators/mod.rs index d197411b..536b33ef 100644 --- a/command-signatures/src/generators/mod.rs +++ b/command-signatures/src/generators/mod.rs @@ -62,6 +62,7 @@ mod screen; mod sdk; mod ssh; mod systemctl; +mod talosctl; mod tar; mod terraform; mod timedatectl; @@ -133,6 +134,7 @@ pub fn dynamic_command_signature_data() -> HashMap