Commit82ce7db

committed

add: coder tunnel docs & coder users ls flags

1 parent3a6edf6 commit82ce7dbCopy full SHA for 82ce7db

File tree

+46

-7

lines changed

+46

-7

lines changed

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`[![GitHub Release](https://img.shields.io/github/v/release/cdr/coder-cli?color=6b9ded&include_prerelease=false)](https://github.com/cdr/coder-cli/releases)`
`4`	`4`	`[![Documentation](https://godoc.org/cdr.dev/coder-cli?status.svg)](https://pkg.go.dev/cdr.dev/coder-cli/coder-sdk)`
`5`	`5`
`6`		`->Note: This is the command line utility for[CoderClassic](https://coder.com/docs/coder).`
	`6`	`+>Note: This is the command line utility for[Coderv1](https://coder.com/docs/coder).`
`7`	`7`	`>If you are using[Coder OSS](https://coder.com/docs/coder-oss/latest), use[these instructions](https://coder.com/docs/coder-oss/latest/install)`
`8`	`8`	`>to install the CLI.`
`9`	`9`

Lines changed: 35 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,35 @@`
	`1`	`+##coder tunnel`
	`2`	`+`
	`3`	`+proxies a port on the workspace to localhost`
	`4`	`+`
	`5`	+```console
	`6`	`+ coder tunnel [workspace_name] [workspace_port] [localhost_port] [flags]`
	`7`	+```
	`8`	`+`
	`9`	`+###Examples`
	`10`	`+`
	`11`	+```console
	`12`	`+#run a tcp tunnel from the workspace on port 3000 to localhost:3000`
	`13`	`+coder tunnel my-dev 3000 3000`
	`14`	`+`
	`15`	`+#run a udp tunnel from the workspace on port 53 to localhost:53`
	`16`	`+coder tunnel --udp my-dev 53 53`
	`17`	+```
	`18`	`+`
	`19`	`+###Options`
	`20`	`+`
	`21`	+```console
	`22`	`+ --address string local address to bind to (default "127.0.0.1")`
	`23`	`+ -h, --help help for tunnel`
	`24`	`+ --max-retry-duration duration maximum amount of time to sleep between retry attempts (default 1m0s)`
	`25`	`+ --retry int number of attempts to retry if the tunnel fails to establish or disconnect (-1 for infinite retries)`
	`26`	`+ --udp tunnel over UDP instead of TCP`
	`27`	+```
	`28`	`+`
	`29`	`+###Options inherited from parent commands`
	`30`	`+`
	`31`	+```console
	`32`	`+ --coder-token string API authentication token.`
	`33`	`+ --coder-url string access url of the Coder deployment. (default "https://demo-2.cdr.dev")`
	`34`	`+ -v, --verbose show verbose output (also settable via CODER_AGENT_VERBOSE) (default true)`
	`35`	+```

Lines changed: 10 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -2,31 +2,35 @@`
`2`	`2`
`3`	`3`	`list all user accounts`
`4`	`4`
`5`		-```
	`5`	+```console
`6`	`6`	`coder users ls [flags]`
`7`	`7`	```
`8`	`8`
`9`	`9`	`###Examples`
`10`	`10`
`11`		-```
	`11`	+```console
`12`	`12`	`coder users ls -o json`
`13`	`13`	`coder users ls -o json \| jq .[] \| jq -r .email`
`14`	`14`	```
`15`	`15`
`16`	`16`	`###Options`
`17`	`17`
`18`		-```
	`18`	+```console
	`19`	`+ --after string returns users in the list after the specified ID`
	`20`	`+ --before string returns users in the list before the specified ID`
`19`	`21`	`-h, --help help for ls`
	`22`	`+ --limit int maximum number of users to return (default 100)`
`20`	`23`	`-o, --output string human \| json (default "human")`
`21`	`24`	```
`22`	`25`
`23`	`26`	`###Options inherited from parent commands`
`24`	`27`
`25`		-```
	`28`	+```console
	`29`	`+ --coder-token string API authentication token.`
	`30`	`+ --coder-url string access url of the Coder deployment. (default "https://demo-2.cdr.dev")`
`26`	`31`	`-v, --verbose show verbose output`
`27`	`32`	```
`28`	`33`
`29`	`34`	`###SEE ALSO`
`30`	`35`
`31`		`-*[coder users](coder_users.md) - Interact with Coder user accounts`
`32`		`-`
	`36`	`+*[coder users](coder_users.md) - Interact with Coder user accounts`

Comments

(0)