talosctl

The command-line client for managing Talos Linux clusters.

Runs as talosctl|macOS, Linux, Windows|www.talos.dev

Command form

ai-draft · 6 tasks · 29 fields

Common Talos Linux node operations: apply a machine config, read resources, read logs, fetch the admin kubeconfig. Insecure/maintenance mode, cluster proxy and many other flags are left out.

Opens the form; the finished command lands at your prompt, unrun

Run in Otty

otty gui talosctl

`talosctl apply-config`

Apply a machine config

Apply a machine configExample values, fixed in this page — nothing here reaches a terminal

Basic

Config file*

file

Nodes*

string

Apply mode

4 choicesenum

Dry run

--dry-run

Config patch

string

TasksEach one presets the form for one job

Dry-run a config

filenodesmodedry_runconfig_patch

Apply a config

filenodesmodeconfig_patch

ParametersOnly these flags are editable in the form

Nodes

Target nodes, comma separated or repeated.
string · repeatable

--nodes-n

Endpoints

Override default endpoints in the Talos configuration.
string · repeatable

--endpoints-e

Talos config file

path

--talosconfig

Config file

path

--file-f

Apply mode

enum

--mode-mautono-rebootstagedtry

Dry run

Check how the config change will be applied without applying it.
boolean

--dry-run

Config patch

Patch to apply to the local config before sending it.
string · repeatable

--config-patch-p

`talosctl get`

Get resources

Get resourcesExample values, fixed in this page — nothing here reaches a terminal

Basic

Resource type*

string

Resource ID

string

Nodes

string

Output

4 choicesenum

TasksEach one presets the form for one job

Get a resource type

typeresource_idnodesoutput

Watch a resource type

typeresource_idnodeswatch

ParametersOnly these flags are editable in the form

Nodes

Target nodes, comma separated or repeated.
string · repeatable

--nodes-n

Endpoints

Override default endpoints in the Talos configuration.
string · repeatable

--endpoints-e

Talos config file

path

--talosconfig

Resource type

Resource type; run `talosctl get rd` to list all types.
string · positional 0

Resource ID

string · positional 1

Output

enum

--output-otablejsonyamljsonpath

Watch changes

boolean

--watch-w

Namespace

string

--namespace

`talosctl logs`

Read logs

Read logsExample values, fixed in this page — nothing here reaches a terminal

Basic

Service or container*

string

Nodes

string

--follow

Tail lines

integer

TasksEach one presets the form for one job

Follow a service log

namenodesfollowtail

ParametersOnly these flags are editable in the form

Nodes

Target nodes, comma separated or repeated.
string · repeatable

--nodes-n

Endpoints

Override default endpoints in the Talos configuration.
string · repeatable

--endpoints-e

Talos config file

path

--talosconfig

Service or container

string · positional 0

boolean

--follow-f

Tail lines

integer

--tail

Log source kind

enum

--kindcontainervmservice

Namespace

system (default), cri for Kubernetes workloads, taloscontainers.
string

--namespacesystemcri

`talosctl kubeconfig`

Fetch the admin kubeconfig

Fetch the admin kubeconfigExample values, fixed in this page — nothing here reaches a terminal

Basic

Local path

any

Nodes

string

Merge with existing kubeconfig

--merge

Force overwrite

--force

TasksEach one presets the form for one job

Download kubeconfig

local_pathnodesmergeforce

ParametersOnly these flags are editable in the form

Nodes

Target nodes, comma separated or repeated.
string · repeatable

--nodes-n

Endpoints

Override default endpoints in the Talos configuration.
string · repeatable

--endpoints-e

Talos config file

path

--talosconfig

Local path

Defaults to the current directory, or ~/.kube/config when merging.
path · positional 0

Merge with existing kubeconfig

boolean

--merge-m

Force overwrite

boolean

--force-f

SourcesEvery flag above is checked against these

docs

talosctl apply-config [flags] -p, --config-patch stringArray the list of config patches to apply to the local config file before sending it to the node --dry-run check how the config change will be applied in dry-run mode -e, --endpoints strings override default endpoints in Talos configurati…

manualv1.15

github.com

docs

talosctl get <type> [<id>] [flags] -e, --endpoints strings override default endpoints in Talos configuration --namespace string resource namespace (default is to use default namespace per resource) -n, --nodes strings target the specified nodes -o, --output string output mode (json, table, yaml, jsonpa…

manualv1.15

github.com

docs

talosctl logs <name> [flags] -e, --endpoints strings override default endpoints in Talos configuration -f, --follow specify if the logs should be streamed --kind string log source kind: container, vm, or service (default: legacy routing) --namespace string namespace to use: "system" (defau…

manualv1.15

github.com

docs

talosctl kubeconfig [local-path] [flags] -e, --endpoints strings override default endpoints in Talos configuration -f, --force Force overwrite of kubeconfig if already present, force overwrite on kubeconfig merge --force-context-name string Force context name for kubeconfig merge -m, --merge…

manualv1.15

github.com

Before it fills your prompt, Otty checks the installed talosctl against its version. A form that does not match your version is not offered.