CLI

The Linkerd CLI is the primary way to interact with Linkerd. It can install the control plane to your cluster, add the proxy to your service and provide detailed metrics for how your service is performing.

As reference, check out the commands below:

CommandDescription
checkCheck the Linkerd installation for potential problems
completionOutput shell completion code for the specified shell (bash, zsh or fish)
diagnosticsCommands used to diagnose Linkerd components
identityDisplay the certificate(s) of one or more selected pod(s)
injectAdd the Linkerd proxy to a Kubernetes config
installOutput Kubernetes configs to install Linkerd
install-cniOutput Kubernetes configs to install Linkerd CNI
jaegerjaeger manages the jaeger extension of Linkerd service mesh
multiclusterManages the multicluster setup for Linkerd
profileOutput service profile config for Kubernetes
repairOutput the secret/linkerd-config-overrides resource if it has been deleted
uninjectRemove the Linkerd proxy from a Kubernetes config
uninstallOutput Kubernetes resources to uninstall Linkerd control plane
upgradeOutput Kubernetes configs to upgrade an existing Linkerd control plane
versionPrint the client and server version information
vizviz manages the linkerd-viz extension of Linkerd service mesh

Global flags

The following flags are available for all linkerd CLI commands:

FlagUsage
—api-addrOverride kubeconfig and communicate directly with the control plane at host:port (mostly for testing)
—contextName of the kubeconfig context to use
—help
-h
help for linkerd
—kubeconfigPath to the kubeconfig file to use for CLI requests
—linkerd-namespace
-l
Namespace in which Linkerd is installed [$LINKERD_NAMESPACE]
—verboseTurn on debug logging