From 3be2545ad4583f5eb74fc185d45c93c4f82a5d50 Mon Sep 17 00:00:00 2001 From: Adam Chalmers Date: Tue, 8 Sep 2020 16:43:47 -0500 Subject: [PATCH] TUN-3292: Mention cleanup in tunnel run help. --- cmd/cloudflared/tunnel/subcommands.go | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/cmd/cloudflared/tunnel/subcommands.go b/cmd/cloudflared/tunnel/subcommands.go index 4c61370e..5c5b4128 100644 --- a/cmd/cloudflared/tunnel/subcommands.go +++ b/cmd/cloudflared/tunnel/subcommands.go @@ -302,8 +302,12 @@ func buildRunCommand() *cli.Command { Action: cliutil.ErrorHandler(runCommand), Usage: "Proxy a local web server by running the given tunnel", ArgsUsage: "TUNNEL-ID", - Hidden: hideSubcommands, - Flags: []cli.Flag{forceFlag, credentialsFileFlag}, + Description: "Runs the tunnel, creating a high-availability connection between your server and the Cloudflare " + + "edge. This command requires the tunnel credentials file created when `cloudflared tunnel create` was run, but " + + "does not require the cert.pem from `cloudflared login`. If you experience problems running the tunnel, " + + "`cloudflared tunnel cleanup` may help by removing any old connection records.", + Hidden: hideSubcommands, + Flags: []cli.Flag{forceFlag, credentialsFileFlag}, } }