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 a background process, the user daemon, to manage the cluster session, and a system service, the root daemon, to modify the workstation's network and DNS so that the cluster's services become available locally.

If Telepresence was installed as a standalone binary, the system service will not be present. A root daemon must then be started using sudo, which may result in a password prompt.

Usage:

  telepresence [command] [flags]

Available Commands:

Command	Description
completion	Generate a shell completion script
compose	Define and run multi-container applications with Telepresence and Docker
config	Telepresence configuration commands
connect	Connect to a cluster
curl	curl with daemon network
docker-run	Docker run with daemon network
gather-logs	Gather logs from traffic-manager, traffic-agent, user and root daemons, and export them into a zip file.
genyaml	Generate YAML for use in kubernetes manifests.
helm	Helm commands using the embedded Telepresence Helm chart.
ingest	Ingest a container
intercept	Intercept a service
leave	Remove existing intercept
list	List current intercepts
list-contexts	Show all contexts
list-namespaces	Show all namespaces
loglevel	Temporarily change the log-level of the traffic-manager, traffic-agent, and user and root daemons
mcp	MCP server management
quit	Tell telepresence daemons to quit
replace	Replace a container
revoke	Revoke an intercept by intercept ID. The intercept ID must be in the format <session_id>:<intercept_name>
serve	Start the browser on a remote service
status	Show connectivity status
uninstall	Uninstall telepresence agents
version	Show version
wiretap	Wiretap a Service

Flags:

  -h, --help   help for telepresence

Global Flags:

      --config string     Path to the Telepresence configuration file (default "$HOME/.config/telepresence/config.yml")
      --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.