Talos CLI

https://docs.siderolabs.com/talos/v1.13/reference/cli
Admin
Talos CLI (talosctl) is a command-line utility used for the out-of-band management and configuration...
Tokens:25,495
Snippets:310
Trust Score:8.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Setup Zsh Completion for Linux

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Generates the Zsh autocompletion script and saves it to a file in the Zsh functions directory for Linux systems.

```zsh
talosctl completion zsh > "${fpath[1]}/_talosctl"
```

--------------------------------

### Create Image Cache from Stdin

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This example demonstrates how to pipe a list of images from standard input to the `talosctl image cache-create` command. This is useful when the image list is generated dynamically or comes from another command.

```bash
talosctl images default | talosctl images cache-create --image-cache-path=/tmp/talos-image-cache --images=-
```

--------------------------------

### talosctl cluster create qemu command

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

The base command for creating a local QEMU-based Talos cluster. Use this command with various flags to customize the cluster setup.

```bash
talosctl cluster create qemu [flags]
```

--------------------------------

### Get Resources with talosctl

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use 'talosctl get' to retrieve specific resources or lists of resources from the Talos OS, similar to 'kubectl get'. Specify the resource type and optionally an ID.

```bash
talosctl get <type> [<id>] [flags]
```

--------------------------------

### Setup Zsh Completion for macOS

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Generates the Zsh autocompletion script and saves it to the Zsh site-functions directory using Homebrew's prefix for macOS systems.

```zsh
talosctl completion zsh > $(brew --prefix)/share/zsh/site-functions/_talosctl
```

--------------------------------

### talosctl cluster create dev Options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This snippet lists the available options for the 'talosctl cluster create dev' command. These flags allow for detailed configuration of the development cluster, including network settings, resource allocation, and installation sources.

```bash
--airgapped                                limit VM network access to the provisioning network only
--arch string                              cluster architecture (default "amd64")
--bad-rtc                                  launch VM with bad RTC state
--cidr string                              CIDR of the cluster network (IPv4, ULA network for IPv6 is derived in automated way) (default "10.5.0.0/24")
--cni-bin-path strings                     search path for CNI binaries (default [/.talos/cni/bin])
--cni-bundle-url string                    URL to download CNI bundle from (default "https://github.com/siderolabs/talos/releases/download/v1.13.0/talosctl-cni-bundle-${ARCH}.tar.gz")
--cni-cache-dir string                     CNI cache directory path (default "/.talos/cni/cache")
--cni-conf-dir string                      CNI config directory path (default "/.talos/cni/conf.d")
--config-injection-method string           a method to inject machine config: default is HTTP server, 'metal-iso' to mount an ISO
--config-patch stringArray                 patch generated machineconfigs (applied to all node types), use @file to read a patch from file
--config-patch-control-plane stringArray   patch generated machineconfigs (applied to 'controlplane' type)
--config-patch-worker stringArray          patch generated machineconfigs (applied to 'worker' type)
--control-plane-port int                   control plane port (load balancer and local API port) (default 6443)
--controlplanes int                        the number of controlplanes to create (default 1)
--cpus string                              the share of CPUs as fraction for each control plane/VM (default "2.0")
--cpus-workers string                      the share of CPUs as fraction for each worker/VM (default "2.0")
--custom-cni-url string                    install custom CNI from the URL (Talos cluster)
--disable-dhcp-hostname                    skip announcing hostname via DHCP
--disk int                                 default limit on disk size in MB (each VM) (default 6144)
--disk-block-size uint                     disk block size (default 512)
--disk-encryption-key-types stringArray    encryption key types to use for disk encryption (uuid, kms) (default [uuid])
--disk-image-path string                   disk image to use
--disk-preallocate                         whether disk space should be preallocated (default true)
--dns-domain string                        the dns domain to use for cluster (default "cluster.local")
--encrypt-ephemeral                        enable ephemeral partition encryption
--encrypt-state                            enable state partition encryption
--encrypt-user-volumes                     enable ephemeral partition encryption
--endpoint string                          use endpoint instead of provider defaults
--extra-boot-kernel-args string            add extra kernel args to the initial boot from vmlinuz and initramfs
--extra-disks int                          number of extra disks to create for each worker VM
--extra-disks-drivers strings              driver for each extra disk (virtio, ide, ahci, scsi, nvme, megaraid)
--extra-disks-serials strings              serials for each extra disk
--extra-disks-size int                     default limit on disk size in MB (each VM) (default 5120)
--extra-disks-tags strings                 tags for each extra disk (only used by virtiofs)
--extra-uefi-search-paths strings          additional search paths for UEFI firmware (only applies when UEFI is enabled)
-h, --help                                     help for dev
--image-cache-path string                  path to image cache
--image-cache-port uint16                  port on which to serve image cache (default 5000)
--image-cache-tls-cert-file string         path to image cache TLS cert
--image-cache-tls-key-file string          path to image cache TLS key
--init-node-as-endpoint                    use init node as endpoint instead of any load balancer endpoint
--initrd-path string                       initramfs image to use (default "_out/initramfs-${ARCH}.xz")
--install-image string                     the installer image to use (default "ghcr.io/siderolabs/installer:v1.13.0")
--ipv4                                     enable IPv4 network in the cluster (default true)
--ipv6                                     enable IPv6 network in the cluster
--ipxe-boot-script string                  iPXE boot script (URL) to use
--iso-path string                          the ISO path to use for the initial boot
```

--------------------------------

### talosctl rollback command usage

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This command allows you to roll back a node to a previous installation. It takes no arguments but supports several flags for configuration.

```bash
talosctl rollback [flags]
```

--------------------------------

### talosctl rollback

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Rolls back a node to its previous installation state. This is useful for reverting to a known good configuration or recovering from failed updates.

```APIDOC
## talosctl rollback

### Description
Rolls back a node to its previous installation. This command is used to revert a node to an earlier version of Talos Linux.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Flags
- **-c, --cluster** (string) - Optional - Cluster to connect to if a proxy endpoint is used.
- **--context** (string) - Optional - Context to be used in command.
- **-e, --endpoints** (strings) - Optional - Override default endpoints in Talos configuration.
- **-h, --help** (boolean) - Optional - Help for rollback command.
- **-n, --nodes** (strings) - Optional - Target the specified nodes.
- **--siderov1-keys-dir** (string) - Optional - 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.
- **--talosconfig** (string) - Optional - 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.
```

--------------------------------

### Get Container Stats with talosctl

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to retrieve statistics for containers on Talos nodes. Flags can be used to specify the cluster, context, endpoints, target nodes, and Kubernetes namespace.

```bash
talosctl stats [flags]
```

--------------------------------

### Generate Talos Cluster Configuration

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to generate configuration files for a new Talos cluster. Specify the cluster name and the API server endpoint. Options allow customization of certificates, machine configurations, installation details, and output formats.

```bash
talosctl gen config <cluster name> <cluster endpoint> [flags]
```

--------------------------------

### Run Conformance Tests (General)

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Initiate conformance tests. Options include specifying the cluster, context, endpoints, and target nodes.

```bash
talosctl conformance [flags]
```

--------------------------------

### Get Server Time with talosctl

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Retrieves the current server time. Can optionally check against a specified NTP server.

```bash
talosctl time [--check server] [flags]
```

--------------------------------

### Generate Secure Boot Database with talosctl

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Generates a UEFI database for enrolling a signing certificate. Paths for the enrolled certificate, signing certificate, and signing key can be specified. Options exist to include well-known UEFI certificates.

```bash
talosctl gen secureboot database [flags]
```

```bash
talosctl gen secureboot database --enrolled-certificate my-cert.pem --signing-certificate my-signing-cert.pem --signing-key my-signing-key.pem
```

```bash
talosctl gen secureboot database --include-well-known-uefi-certs
```

```bash
talosctl gen secureboot database -h
```

```bash
talosctl gen secureboot database --force
```

```bash
talosctl gen secureboot database -o ./build
```

--------------------------------

### Override Default Endpoints

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Manually specify the Talos configuration endpoints, overriding the defaults. This is useful for direct connections or custom network setups.

```bash
-e, --endpoints strings          override default endpoints in Talos configuration
```

--------------------------------

### Configure Serving Address and Cache Path

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Specify the address to serve the registry on and the directory for the image cache. Defaults are provided if not specified.

```bash
talosctl image cache-serve --address 127.0.0.1:3172 --image-cache-path /path/to/cache
```

--------------------------------

### Run Kubernetes Conformance Tests

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Execute Kubernetes conformance tests. Use the --mode flag to specify the test mode.

```bash
talosctl conformance kubernetes [flags]
```

--------------------------------

### Configure TLS for Secure Serving

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use TLS certificate and key files to serve the registry securely over HTTPS. Ensure the certificate and key files are correctly specified.

```bash
talosctl image cache-serve --tls-cert-file cert.pem --tls-key-file key.pem
```

--------------------------------

### talosctl upgrade-k8s Synopsis

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This is the basic command structure for upgrading the Kubernetes control plane. Use this to understand the command's entry point.

```bash
talosctl upgrade-k8s [flags]
```

--------------------------------

### Upgrade Talos on Target Nodes

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Upgrades the Talos Linux installation on specified nodes. Supports various options for image selection, draining nodes, and reboot modes.

```bash
talosctl upgrade [flags]
```

--------------------------------

### Manage etcd Downgrades

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This command is the entry point for managing etcd storage system downgrades. It provides subcommands for enabling, disabling, canceling, and validating downgrades.

```bash
talosctl etcd downgrade
```

--------------------------------

### talosctl config new command syntax

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to generate a new client configuration file. You can optionally specify a path for the new file.

```bash
talosctl config new [<path>] [flags]
```

--------------------------------

### talosctl cluster create docker inherited options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

These options are inherited from parent commands and apply to 'talosctl cluster create docker'. They include cluster naming and state directory configuration.

```bash
--name string
 the name of the cluster (default "talos-default")
--state string
 directory path to store cluster state (default "/.talos/clusters")
```

--------------------------------

### Inspect Controller-Resource Dependencies

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Inspects controller-resource dependencies and outputs them in a format that can be processed by the 'dot' command for graph visualization. Use the --with-resources flag to include live resource information.

```bash
talosctl inspect dependencies | dot -Tpng > graph.png
```

```bash
talosctl inspect dependencies [flags]
```

--------------------------------

### List Container Images

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Lists images available in the machine's container runtime. Use this command to check existing images.

```bash
talosctl image list [flags]
```

```bash
talosctl image list [flags]
```

--------------------------------

### Control Talos Service State

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use 'talosctl service' to manage the state of services on Talos nodes. Without arguments, it lists all services and their states. Specify a service ID with actions like 'start', 'stop', 'restart', or 'status' to control individual services.

```bash
talosctl service [<id> [start|stop|restart|status]] [flags]
```

--------------------------------

### Kubernetes Conformance Test Options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Configure Kubernetes conformance tests with specific modes. The default mode is 'fast'.

```bash
-h, --help          help for kubernetes
      --mode string   conformance test mode: [fast, certified, network-policy] (default "fast")
```

--------------------------------

### talosctl config new command options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

These are the specific options for the 'new' command, including certificate TTL, help flags, and roles.

```bash
      --crt-ttl duration   certificate TTL (default 8760h0m0s)
  -h, --help               help for new
      --roles strings      roles (default [os:admin])
```

--------------------------------

### talosctl inspect command options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Lists the available options for the 'talosctl inspect' command. Use these flags to specify cluster, context, endpoints, nodes, and configuration paths.

```bash
talosctl inspect [flags]
```

--------------------------------

### Talos CLI Cluster Create Docker Options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Configure a Docker-based Talos cluster, specifying resources, networking, and Talos image.

```bash
      --config-patch stringArray                 patch generated machineconfigs (applied to all node types), use @file to read a patch from file
      --config-patch-controlplanes stringArray   patch generated machineconfigs (applied to 'controlplane' type)
      --config-patch-workers stringArray         patch generated machineconfigs (applied to 'worker' type)
      --cpus-controlplanes string                the share of CPUs as fraction for each control plane/VM (default "2.0")
      --cpus-workers string                      the share of CPUs as fraction for each worker/VM (default "2.0")
  -p, --exposed-ports string                     comma-separated list of ports/protocols to expose on init node. Ex -p <hostPort>:<containerPort>/<protocol (tcp or udp)>
  -h, --help                                     help for docker
      --host-ip string                           Host IP to forward exposed ports to (default "0.0.0.0")
      --image string                             the talos image to run (default "ghcr.io/siderolabs/talos:v1.13.0")
      --kubernetes-version string                desired kubernetes version to run (default "1.36.0")
      --memory-controlplanes string(mb,gb)       the limit on memory usage for each control plane/VM (default 2.0GiB)
      --memory-workers string(mb,gb)             the limit on memory usage for each worker/VM (default 2.0GiB)
      --mount mount                              attach a mount to the container (docker --mount syntax)
      --subnet string                            Docker network subnet CIDR (default "10.5.0.0/24")
      --talosconfig-destination string           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.
      --workers int                              the number of workers to create (default 1)
```

--------------------------------

### General Conformance Test Options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Configure general conformance tests. Options control cluster connection, context, endpoints, and node targeting.

```bash
-c, --cluster string             Cluster to connect to if a proxy endpoint is used.
      --context string             Context to be used in command
  -e, --endpoints strings          override default endpoints in Talos configuration
  -h, --help                       help for conformance
  -n, --nodes strings              target the specified nodes
      --siderov1-keys-dir string   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.
      --talosconfig string         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.
```

--------------------------------

### Bootstrap etcd cluster

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to bootstrap the etcd cluster on a control plane node. This is typically done once during cluster creation.

```bash
talosctl bootstrap [flags]
```

--------------------------------

### Show talosctl config info

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Displays information about the current Talos cluster context. You can specify the output format.

```bash
talosctl config info [flags]
```

--------------------------------

### Serve OCI Image Cache Directory

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to serve an OCI image cache directory over HTTP(S) as a container registry. Configure the address, cache path, and mirrors as needed.

```bash
talosctl image cache-serve [flags]
```

--------------------------------

### talosctl gen secureboot uki Command

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to generate a certificate for signing boot assets (UKI). It accepts flags for common name and help, along with inherited flags.

```bash
talosctl gen secureboot uki [flags]
```

```bash
--common-name string   common name for the certificate (default "Test UKI Signing Key")
-h, --help                 help for uki
```

```bash
-f, --force           will overwrite existing files
-o, --output string   path to the directory storing the generated files (default "_out")
```

--------------------------------

### talosctl cluster create docker options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

These are the specific options for the 'talosctl cluster create docker' command. They allow customization of the Docker-based cluster, including resource allocation, exposed ports, and Talos image.

```bash
--config-patch stringArray
 patch generated machineconfigs (applied to all node types), use @file to read a patch from file
--config-patch-controlplanes stringArray
 patch generated machineconfigs (applied to 'controlplane' type)
--config-patch-workers stringArray
 patch generated machineconfigs (applied to 'worker' type)
--cpus-controlplanes string
 the share of CPUs as fraction for each control plane/VM (default "2.0")
--cpus-workers string
 the share of CPUs as fraction for each worker/VM (default "2.0")
-p, --exposed-ports string
 comma-separated list of ports/protocols to expose on init node. Ex -p <hostPort>:<containerPort>/<protocol (tcp or udp)>
-h, --help
 help for docker
--host-ip string
 Host IP to forward exposed ports to (default "0.0.0.0")
--image string
 the talos image to run (default "ghcr.io/siderolabs/talos:v1.13.0")
--kubernetes-version string
 desired kubernetes version to run (default "1.36.0")
--memory-controlplanes string(mb,gb)
 the limit on memory usage for each control plane/VM (default 2.0GiB)
--memory-workers string(mb,gb)
 the limit on memory usage for each worker/VM (default 2.0GiB)
--mount mount
 attach a mount to the container (docker --mount syntax)
--subnet string
 Docker network subnet CIDR (default "10.5.0.0/24")
--talosconfig-destination string
 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.
--workers int
 the number of workers to create (default 1)
```

--------------------------------

### List Default Kubernetes Images

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to list the default Kubernetes images that Talos utilizes. Flags can be used to specify versions for components like CoreDNS, etcd, Flannel, and Kubernetes itself.

```bash
talosctl image k8s-bundle [flags]
```

--------------------------------

### Specify SideroV1 Keys Directory

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Set the path to the SideroV1 authentication PGP keys directory. It defaults to the 'SIDEROV1_KEYS_DIR' environment variable or '$HOME/.talos/keys'. This is only applicable for contexts using SideroV1 authentication.

```bash
--siderov1-keys-dir string   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.
```

--------------------------------

### List Talos System Images and Extensions

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This command lists the default system images and extensions used by Talos. You can optionally include images belonging to Talos extensions and overlays.

```bash
talosctl image talos-bundle [talos-version] [flags]
```

--------------------------------

### List Defined Talos Contexts

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This command lists all the contexts that are currently defined in your Talos configuration file. No arguments are required.

```bash
talosctl config contexts [flags]
```

--------------------------------

### talosctl list command usage

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Shows the basic syntax for the talosctl list command. Use this to retrieve a directory listing from a Talos node.

```bash
talosctl list [path] [flags]
```

--------------------------------

### talosctl image talos-bundle

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

List the default system images and extensions used for Talos. This command helps in identifying the core images that Talos itself relies on.

```bash
talosctl image talos-bundle
```

--------------------------------

### Talos CLI Options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Common options available for talosctl commands, including cluster connection, context selection, and endpoint overrides.

```bash
-h, --help   help for write
```

```bash
-c, --cluster string             Cluster to connect to if a proxy endpoint is used.
```

```bash
--context string             Context to be used in command
```

```bash
-e, --endpoints strings          override default endpoints in Talos configuration
```

```bash
-i, --insecure                   write|delete meta using the insecure (encrypted with no auth) maintenance service
```

```bash
-n, --nodes strings              target the specified nodes
```

```bash
--siderov1-keys-dir string   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.
```

```bash
--talosconfig string         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.
```

--------------------------------

### Talos CLI Global Options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

These options are inherited by most talosctl commands and control cluster naming and state directory.

```bash
      --name string    the name of the cluster (default "talos-default")
      --state string   directory path to store cluster state (default "/.talos/clusters")
```

--------------------------------

### talosctl config merge command options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

These are the specific options for the 'merge' command, including help flags.

```bash
-h, --help   help for merge
```

--------------------------------

### Add Registry Mirrors

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Provide a list of registry mirrors to be added to the Talos config patch. Default mirrors include docker.io, ghcr.io, and registry.k8s.io.

```bash
talosctl image cache-serve --mirror docker.io,myregistry.com
```

--------------------------------

### Print talosctl version

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Prints the version of the talosctl client and potentially the cluster. Use flags to specify client-only version or short format.

```bash
talosctl version [flags]
```

--------------------------------

### talosctl image cache-serve

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Serve an OCI image cache directory over HTTP(S) as a container registry. This allows other systems to pull images from the cache.

```bash
talosctl image cache-serve <cache-dir>
```

--------------------------------

### Create Image Cache

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to create a cache of specified container images in OCI format within a given directory. Ensure the `--images` and `--image-cache-path` flags are correctly set.

```bash
talosctl image cache-create --images=ghcr.io/siderolabs/kubelet:v1.36.0 --image-cache-path=/tmp/talos-image-cache
```

--------------------------------

### List Mounts with talosctl

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to list the mounts on Talos nodes. It accepts flags to specify the cluster, context, endpoints, and target nodes.

```bash
talosctl mounts [flags]
```

--------------------------------

### talosctl cluster show command

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Displays information about a locally provisioned Talos Kubernetes cluster. You can specify the provisioner and cluster name.

```bash
talosctl cluster show [flags]
```

```bash
talosctl cluster show --provisioner docker
```

```bash
talosctl cluster show --name my-cluster
```

```bash
talosctl cluster show --state "/custom/state/dir"
```

--------------------------------

### Set Command Context

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Define the context to be used for the command. This allows switching between different configurations or environments.

```bash
--context string             Context to be used in command
```

--------------------------------

### Retrieve Kernel Logs with talosctl dmesg

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to fetch kernel logs from Talos nodes. The --follow flag streams logs in real-time, and --tail can be used with --follow to only show new messages.

```bash
talosctl dmesg [flags]
```

--------------------------------

### talosctl image cache-create

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Create a cache of container images in OCI format into a specified directory. This is useful for offline image distribution or faster deployments.

```bash
talosctl image cache-create <output-dir>
```

--------------------------------

### Specify Target Namespace

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Set the namespace for Talos operations. Options include 'system' for etcd and kubelet images, 'cri' for all Kubernetes workloads, and 'inmem' for in-memory containerd instances.

```bash
--namespace string           namespace to use: "system" (etcd and kubelet images), "cri" for all Kubernetes workloads, "inmem" for in-memory containerd instance (default "cri")
```

--------------------------------

### talosctl kubeconfig command synopsis

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Synopsis for the 'talosctl kubeconfig' command. This command downloads the admin kubeconfig from a node.

```bash
talosctl kubeconfig [local-path] [flags]
```

--------------------------------

### Run talosctl debug from image reference

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to run a debug container from an image reference (e.g., a Docker image). Talos will pull the image if it's not already present. Specify the image reference and any arguments for the container.

```bash
talosctl debug docker.io/library/alpine:latest --args /bin/sh
```

--------------------------------

### talosctl gen secureboot Command

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This is the main command for generating secure boot secrets. It accepts flags for help and output directory, with inherited flags for force overwrite.

```bash
talosctl gen secureboot [flags]
```

```bash
-h, --help            help for secureboot
-o, --output string   path to the directory storing the generated files (default "_out")
```

```bash
-f, --force   will overwrite existing files
```

--------------------------------

### Specify Kubernetes Version

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Customize the Kubernetes version used in the bundle by providing a semantic version string.

```bash
--k8s-version semver                     Kubernetes semantic version (default v1.36.0)
```

--------------------------------

### talosctl restart command options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

These are the available options for the 'talosctl restart' command, allowing customization of the restart operation.

```bash
  -c, --cluster string             Cluster to connect to if a proxy endpoint is used.
      --context string             Context to be used in command
  -e, --endpoints strings          override default endpoints in Talos configuration
  -h, --help                       help for restart
  -k, --kubernetes                 use the k8s.io containerd namespace
  -n, --nodes strings              target the specified nodes
      --siderov1-keys-dir string   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.
      --talosconfig string         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.
```

--------------------------------

### talosctl image talos-bundle

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Lists the default system images and extensions used for Talos. It can optionally include images from Talos extensions and overlays.

```APIDOC
## talosctl image talos-bundle

### Description
Lists the default system images and extensions used for Talos.

### Method
Not applicable (CLI command)

### Endpoint
Not applicable (CLI command)

### Parameters
#### Path Parameters
- **talos-version** (string) - Optional - The Talos version for which to list images.

#### Flags
- **--extensions** (bool) - Include images that belong to Talos extensions (default true)
- **-h, --help** (bool) - help for talos-bundle
- **--overlays** (bool) - Include images that belong to Talos overlays (default true)

#### Inherited Flags
- **-c, --cluster** (string) - Cluster to connect to if a proxy endpoint is used.
- **--context** (string) - Context to be used in command
- **-e, --endpoints** (strings) - override default endpoints in Talos configuration
- **--namespace** (string) - namespace to use: "system" (etcd and kubelet images), "cri" for all Kubernetes workloads, "inmem" for in-memory containerd instance (default "cri")
- **-n, --nodes** (strings) - target the specified nodes
- **--siderov1-keys-dir** (string) - 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.
- **--talosconfig** (string) - 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.
```

--------------------------------

### talosctl etcd downgrade enable Command

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to enable etcd storage system downgrade to a specific version. It requires the target version as an argument and accepts additional flags.

```bash
talosctl etcd downgrade enable <version> [flags]
```

```bash
-h, --help   help for enable
```

```bash
-c, --cluster string             Cluster to connect to if a proxy endpoint is used.
```

```bash
--context string             Context to be used in command
```

```bash
-e, --endpoints strings          override default endpoints in Talos configuration
```

```bash
-n, --nodes strings              target the specified nodes
```

```bash
--siderov1-keys-dir string   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.
```

```bash
--talosconfig string         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.
```

--------------------------------

### talosctl list command options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Lists available options for the talosctl list command. These flags control the output format, recursion depth, and filtering of directory listings.

```bash
  -c, --cluster string             Cluster to connect to if a proxy endpoint is used.
      --context string             Context to be used in command
  -d, --depth int32                maximum recursion depth (default 1)
  -e, --endpoints strings          override default endpoints in Talos configuration
  -h, --help                       help for list
  -H, --humanize                   humanize size and time in the output
  -l, --long                       display additional file details
  -n, --nodes strings              target the specified nodes
  -r, --recurse                    recurse into subdirectories
      --siderov1-keys-dir string   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.
      --talosconfig string         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.
  -t, --type strings               filter by specified types:
                                   f	regular file
                                   d	directory
                                   l, L	symbolic link
```

--------------------------------

### talosctl logs command options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Lists available options for the talosctl logs command. These flags control log streaming, filtering by node, and specifying the number of lines to display.

```bash
  -c, --cluster string             Cluster to connect to if a proxy endpoint is used.
      --context string             Context to be used in command
  -e, --endpoints strings          override default endpoints in Talos configuration
  -f, --follow                     specify if the logs should be streamed
  -h, --help                       help for logs
  -k, --kubernetes                 use the k8s.io containerd namespace
  -n, --nodes strings              target the specified nodes
      --siderov1-keys-dir string   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.
      --tail int32                 lines of log file to display (default is to show from the beginning) (default -1)
      --talosconfig string         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.
```

--------------------------------

### talosctl gen secureboot pcr Command

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to generate a key for signing TPM PCR values. It accepts flags for help.

```bash
talosctl gen secureboot pcr [flags]
```

```bash
-h, --help   help for pcr
```

```bash
-f, --force           will overwrite existing files
-o, --output string   path to the directory storing the generated files (default "_out")
```

--------------------------------

### talosctl config node command options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

These are the specific options available for the `talosctl config node` command.

```bash
-h, --help   help for node
```

--------------------------------

### talosctl cluster create docker command usage

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This is the basic usage of the talosctl cluster create docker command. It shows the command and its available flags for creating a Docker-based cluster.

```bash
talosctl cluster create docker [flags]
```

--------------------------------

### Apply Configuration to a Node

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to apply a new configuration to a Talos node. You can specify various flags to control the application process, such as configuration files, patches, modes, and security settings.

```bash
talosctl apply-config [flags]
```

--------------------------------

### talosctl image list

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

List images available in the machine's container runtime. This command helps to inspect the current state of images on a node.

```bash
talosctl image list
```

--------------------------------

### talosctl containers command

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Lists containers on Talos nodes. Use flags to specify the cluster, context, endpoints, nodes, or Kubernetes namespace.

```bash
talosctl containers [flags]
```

--------------------------------

### Generate SecureBoot Secrets with talosctl

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use 'talosctl gen secureboot' to generate secrets specifically for the SecureBoot process, ensuring a secure boot environment.

```bash
talosctl gen secureboot --force
```

--------------------------------

### Run talosctl debug from local tar archive

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to load an image from a local tar archive into Talos and run a debug container. Specify the path to the tar archive and any arguments for the container.

```bash
talosctl debug ./debug-tools.tar --args /bin/sh
```

--------------------------------

### talosctl image k8s-bundle

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

List the default Kubernetes images used by Talos. This command is helpful for understanding the default image dependencies for Kubernetes.

```bash
talosctl image k8s-bundle
```

--------------------------------

### Specify Talos Configuration Path

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Define the path to the Talos configuration file. It defaults to the 'TALOSCONFIG' environment variable, then '$HOME/.talos/config', and finally '/var/run/secrets/talos.dev/config'.

```bash
--talosconfig string         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.
```

--------------------------------

### talosctl dashboard command

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This is the base command for launching the talosctl dashboard. It can be used with various flags to customize its behavior.

```bash
talosctl dashboard [flags]
```

--------------------------------

### talosctl etcd snapshot command

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Streams a snapshot of the etcd node to a specified path. Use this command to back up your etcd data.

```bash
talosctl etcd snapshot <path> [flags]
```

```bash
-h, --help   help for snapshot
```

```bash
-c, --cluster string             Cluster to connect to if a proxy endpoint is used.
```

```bash
--context string             Context to be used in command
```

```bash
-e, --endpoints strings          override default endpoints in Talos configuration
```

```bash
-n, --nodes strings              target the specified nodes
```

```bash
--siderov1-keys-dir string   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.
```

```bash
--talosconfig string         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.
```

--------------------------------

### Talos META Command Options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Options specific to the talosctl meta command, including insecure write/delete operations and node targeting.

```bash
-c, --cluster string             Cluster to connect to if a proxy endpoint is used.
```

```bash
--context string             Context to be used in command
```

```bash
-e, --endpoints strings          override default endpoints in Talos configuration
```

```bash
-h, --help                       help for meta
```

```bash
-i, --insecure                   write|delete meta using the insecure (encrypted with no auth) maintenance service
```

```bash
-n, --nodes strings              target the specified nodes
```

```bash
--siderov1-keys-dir string   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.
```

```bash
--talosconfig string         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.
```

--------------------------------

### talosctl cluster create dev Command Usage

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This snippet shows the basic usage of the 'talosctl cluster create dev' command. It is used to initiate the creation of a local development cluster.

```bash
talosctl cluster create dev [flags]
```

--------------------------------

### Generate Secrets Bundle with talosctl

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use 'talosctl gen secrets' to create a secrets bundle file. This file can be used later to generate a Talos configuration.

```bash
talosctl gen secrets --force
```

--------------------------------

### talosctl config info

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Displays information about the current Talos CLI context, including cluster details and configuration.

```APIDOC
## talosctl config info

### Description
Show information about the current context

### Usage
talosctl config info [flags]

### Options
#### Flags
-h, --help            help for info
-o, --output string   output format (json|yaml|text). Default text. (default "text")

### Options inherited from parent commands
#### Flags
-c, --cluster string
    Cluster to connect to if a proxy endpoint is used.
--context string
    Context to be used in command
-e, --endpoints strings
    override default endpoints in Talos configuration
-n, --nodes strings
    target the specified nodes
--siderov1-keys-dir string
    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.
--talosconfig string
    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.

### SEE ALSO
* [talosctl config](#talosctl-config)	 - Manage the client configuration file (talosconfig)
```

--------------------------------

### Specify Kube Network Policies Version

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Customize the kube-network-policies version used in the bundle by providing a semantic version string.

```bash
--kube-network-policies-version semver   kube-network-policies semantic version (default v1.0.0)
```

--------------------------------

### Write Key-Value to Talos META Partition

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to write a key-value pair to the META partition of a Talos cluster. It accepts flags for specifying the cluster, context, endpoints, and security options.

```bash
talosctl meta write key value [flags]
```

--------------------------------

### talosctl logs command usage

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Shows the basic syntax for the talosctl logs command. Use this to retrieve logs for a specific service on a Talos node.

```bash
talosctl logs <service name> [flags]
```

--------------------------------

### talosctl cgroups command

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This is the base command for retrieving cgroups usage information. Flags can be used to specify presets or custom schemas.

```bash
talosctl cgroups [flags]
```

--------------------------------

### talosctl wipe command options

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

This displays the available options for the talosctl wipe command. Use these flags to specify the target cluster, nodes, endpoints, and configuration paths.

```bash
talosctl wipe --help
```

--------------------------------

### Generate Key Pair with talosctl

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use 'talosctl gen keypair' to generate an X.509 Ed25519 key pair, which includes both a private key and a corresponding public certificate.

```bash
talosctl gen keypair --force
```

--------------------------------

### Generate Secrets Bundle with talosctl

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Generates a secrets bundle file for Talos configuration. It can use existing control plane configurations or Kubernetes PKI directories as input. The output file path can be specified, defaulting to stdout.

```bash
talosctl gen secrets [flags]
```

```bash
talosctl gen secrets --from-controlplane-config my-config.yaml
```

```bash
talosctl gen secrets -p /etc/kubernetes/pki
```

```bash
talosctl gen secrets -t <token>
```

```bash
talosctl gen secrets -o secrets.yaml
```

```bash
talosctl gen secrets --talos-version v0.8
```

```bash
talosctl gen secrets --force
```

--------------------------------

### Load Zsh Completion

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Generates and loads the autocompletion script for Zsh in the current session using the source command.

```zsh
source <(talosctl completion zsh)
```

--------------------------------

### talosctl config merge command syntax

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to merge additional contexts from another client configuration file. Contexts with the same name are renamed during the merge process.

```bash
talosctl config merge <from> [flags]
```

--------------------------------

### talosctl usage: Retrieve Disk Usage

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to check disk usage on specified paths. Flags can modify the output, such as showing all files or humanizing the output.

```bash
talosctl usage [path1] [path2] ... [pathN] [flags]
```

--------------------------------

### Generate Key Pair with talosctl

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Use this command to generate an X.509 Ed25519 key pair. Flags can specify IP addresses or organization details for the certificate.

```bash
talosctl gen keypair [flags]
```

```bash
talosctl gen keypair --ip 192.168.1.10 --organization "MyCompany"
```

```bash
talosctl gen keypair -h
```

```bash
talosctl gen keypair --force
```

--------------------------------

### Specify ETCD Version

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Customize the ETCD version used in the Kubernetes bundle by providing a semantic version string.

```bash
--etcd-version semver                    ETCD semantic version (default v3.6.9)
```

--------------------------------

### Add New Talos Context

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

Adds a new context to the Talos client configuration. Specify the context name and provide paths to the CA certificate, client certificate, and client key.

```bash
talosctl config add <context> --ca <path/to/ca.crt> --crt <path/to/client.crt> --key <path/to/client.key>
```

--------------------------------

### Inherited Options for talosctl

Source: https://docs.siderolabs.com/talos/v1.13/reference/cli

These options are inherited from parent commands and can be used to specify the cluster, context, endpoints, namespace, target nodes, SideroV1 keys directory, and Talos configuration file path.

```bash
talosctl image cache-serve -c mycluster -n node1,node2 --talosconfig ~/.talos/config
```
Tokens:
Raw