rancher
The Rancher CLI (Command Line Interface) is a unified tool that you can use to interact with Rancher
Subcommands
| Name | Description |
|---|---|
apps, app | Operations with apps. Uses helm. Flags are prepended with 'helm' can also be accurately described by helm documentation |
catalog | Operations with catalogs |
clusters, cluster | Operations on clusters |
context | Operations for the context |
globaldns | Operations on global DNS providers and entries |
inspect | View details of resources |
kubectl | Run kubectl commands |
login, -l | Login to a Rancher server |
machines, machine | Operations on machines |
multiclusterapps, multiclusterapp | Operations with multi-cluster apps |
namespaces, namespace | Operations on namespaces |
nodes, node | Operations on nodes |
projects, project | Operations on projects |
ps | Show workloads in a project |
server | Operations for the server |
settings, setting | Show settings for the current server |
ssh | SSH into a node |
up | Apply compose config |
wait | Wait for resources cluster, app, project, multiClusterApp |
token | Authenticate and generate new kubeconfig token |
help, h | Shows a list of commands or help for one command |
Options
| Name | Description |
|---|---|
--debug | Debug logging |
--config, -c <RANCHER_CONFIG_PATH> | Path to rancher config (default: `$home/.rancher`) [$RANCHER_CONFIG_DIR] |
--help, -h | Show help for rancher cli |
--version, -v | Print the version |