Add documentation for tsh proxy app (gravitational#10924)

ozen · Mar 14, 2022 · 823fc29 · 823fc29
1 parent 9f68e11
commit 823fc29
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/docs/pages/setup/reference/cli.mdx b/docs/pages/setup/reference/cli.mdx
@@ -311,6 +311,42 @@ $ tsh play --format=pty 1fe153d1-ce8b-4ef4-9908-6539457ba4ad.tar
 $ tsh play --format=json ~/play/0c0b81ed-91a9-4a2a-8d7c-7495891a6ca0.tar | jq '.event
 ```
 
+### tsh proxy app
+
+Starts a local TLS proxy for Application Access connections. 
+You can use this proxy to connect to an application repeatedly after a single login to your Teleport cluster,
+which is especially useful for interacting with an application via a CLI.
+
+```code
+$ tsh proxy app [<flags>] <app>
+```
+
+#### Arguments
+`<app>`
+
+- `app` The name of the application to start the local proxy for. To see a list of available applications, run `tsh apps ls`.
+
+#### Flags
+
+| Name | Default Value(s) | Allowed Value(s) | Description |
+| - | - | - | - |
+| `--port` | none | port number | Specify the source port for the local proxy |
+
+#### [Global Flags](#tsh-global-flags)
+
+These flags are available for all commands `--login, --proxy, --user, --ttl, --identity, --cert-format, --insecure, --auth, --skip-version-check, --debug, --jumphost, --format`.
+Run `tsh help <subcommand>` or see the [Global Flags Section](#tsh-global-flags)
+
+#### Examples 
+```code
+$ tsh proxy app <app>
+
+# Proxy a connection to grafana on local port 10700
+$ tsh proxy --port 10700 app grafana &
+# Proxying connections to grafana on 127.0.0.1:10700
+$ curl http://127.0.0.1:10700/api/users
+```
+
 ### tsh scp
 
 Copies files from source to dest: