CLI

The Linkerd CLI is the primary way to interact with Linkerd. It can install thecontrol plane to your cluster, add the proxy to your service and providedetailed 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 or zsh)
dashboardOpen the Linkerd dashboard in a web browser
edgesDisplay connections between resources, and Linkerd proxy identities
endpointsIntrospect Linkerd's service discovery state
getDisplay one or many mesh resources
injectAdd the Linkerd proxy to a Kubernetes config
installOutput Kubernetes configs to install Linkerd
install-cniOutput Kubernetes configs to install Linkerd CNI (experimental)
install-spOutput Kubernetes configs to install Linkerd Service Profiles
logsTail logs from containers in the Linkerd control plane
metricsFetch metrics directly from Linkerd proxies
profileOutput service profile config for Kubernetes
routesDisplay route stats
statDisplay traffic stats about one or many resources
tapListen to a traffic stream
topDisplay sorted information about live traffic
uninjectRemove the Linkerd proxy from a Kubernetes config
upgradeOutput Kubernetes configs to upgrade an existing Linkerd control plane
versionPrint the client and server version information

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-hhelp for linkerd
—kubeconfigPath to the kubeconfig file to use for CLI requests
—linkerd-namespace-lNamespace in which Linkerd is installed [$LINKERD_NAMESPACE]
—verboseTurn on debug logging