Skip to main content
Version: 2.24

telepresence

Connect your workstation to a Kubernetes cluster

Synopsis:

Telepresence can connect to a cluster and route all outbound traffic from your workstation to that cluster so that software running locally can communicate as if it executed remotely, inside the cluster. This is achieved using the command:

telepresence connect

Telepresence can also intercept traffic intended for a specific service in a cluster and redirect it to your local workstation:

telepresence intercept <name of service>

Telepresence uses background processes to manage the cluster session. One of the processes runs with superuser privileges because it modifies the network. Unless the daemons are already started, an attempt will be made to start them. This will involve a call to sudo unless this command is run as root (not recommended) which in turn may result in a password prompt.

Usage:

  telepresence [command] [flags]

Available Commands:

CommandDescription
completionGenerate a shell completion script
composeDefine and run multi-container applications with Telepresence and Docker
configTelepresence configuration commands
connectConnect to a cluster
curlcurl with daemon network
docker-runDocker run with daemon network
gather-logsGather logs from traffic-manager, traffic-agent, user and root daemons, and export them into a zip file.
genyamlGenerate YAML for use in kubernetes manifests.
helmHelm commands using the embedded Telepresence Helm chart.
ingestIngest a container
interceptIntercept a service
leaveRemove existing intercept
listList current intercepts
list-contextsShow all contexts
list-namespacesShow all namespaces
loglevelTemporarily change the log-level of the traffic-manager, traffic-agent, and user and root daemons
quitTell telepresence daemons to quit
replaceReplace a container
serveStart the browser on a remote service
statusShow connectivity status
uninstallUninstall telepresence agents
versionShow version
wiretapWiretap a Service

Flags:

  -h, --help   help for telepresence

Global Flags:

      --output string     Set the output format, supported values are 'json', 'yaml', and 'default' (default "default")
--progress string Set type of progress output (auto, tty, plain, json, quiet) (default "auto")
--use string Match expression that uniquely identifies the daemon container

Use telepresence [command] --help for more information about a command.