Install talosctl

talosctl is a command-line tool for interacting with the Talos API and managing Talos machines.

Follow the instructions below to install it on your operating system:

Linux and macOS

The easiest way to install talosctl is via Homebrew:

brew install siderolabs/tap/sidero-tools

This method ensures that talosctl stays up to date automatically when new versions are released. The same tap also includes a formula for omnictl.

For manual or Windows installation, see the alternate installation methods in the Talos documentation.

Omni-managed clusters and permissions

When managing Talos nodes through Omni, certain privileged talosctl commands are restricted.

All os:admin role commands except for a select few are not allowed to run against the Talos machines connected to Omni.

The following os:admin commands are allowed when accessing Talos machines through Omni:

Allowed commands
talosctl etcd alarm list
talosctl etcd alarm disarm
talosctl etcd defrag
talosctl etcd status
talosctl pcap
talosctl reboot
talosctl restart
talosctl service <id> [stop|start|restart]
talosctl shutdown

Sensitive resources

Omni restricts access to machine configuration because it may contain sensitive PKI material. To see which resources are not accessible, run:

talosctl get rds -o json | jq -s '.[] | select(.spec.sensitivity=="sensitive") | .metadata.id'