opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): rework CLI docs (#6312)

Browse Source
This commit is contained in:
Ammar Bandukwala
2023-02-23 01:53:21 +00:00
committed by GitHub
parent 43e8ba0811
commit f6a8c360e5
71 changed files with 2342 additions and 2087 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cli/coder_port-forward.md
+23 -32
View File
@@ -1,14 +1,18 @@
## coder port-forward
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder port-forward
Forward ports from machine to a workspace
```
## Usage
```console
coder port-forward <workspace> [flags]
```
### Examples
## Examples
```
```console
- Port forward a single TCP port from 1234 in the workspace to port 5678 on
your local machine:
@@ -28,35 +32,22 @@ coder port-forward <workspace> [flags]
$ coder port-forward <workspace> --tcp 8080,9000:3000,9090-9092,10000-10002:10010-10012
```
### Options
## Flags
```
-h, --help help for port-forward
-p, --tcp stringArray Forward TCP port(s) from the workspace to the local machine.
Consumes $CODER_PORT_FORWARD_TCP
--udp stringArray Forward UDP port(s) from the workspace to the local machine. The UDP connection has TCP-like semantics to support stateful UDP protocols.
Consumes $CODER_PORT_FORWARD_UDP
```
### --tcp, -p
### Options inherited from parent commands
Forward TCP port(s) from the workspace to the local machine.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PORT_FORWARD_TCP</code> |
| Default | <code>[]</code> |
```
--global-config coder Path to the global coder config directory.
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
Consumes $CODER_HEADER
--no-feature-warning Suppress warnings about unlicensed features.
Consumes $CODER_NO_FEATURE_WARNING
--no-version-warning Suppress warning when client and server versions do not match.
Consumes $CODER_NO_VERSION_WARNING
--token string Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
Consumes $CODER_SESSION_TOKEN
--url string URL to a deployment.
Consumes $CODER_URL
-v, --verbose Enable verbose output.
Consumes $CODER_VERBOSE
```
### --udp
### SEE ALSO
- [coder](coder.md) -
Forward UDP port(s) from the workspace to the local machine. The UDP connection has TCP-like semantics to support stateful UDP protocols.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PORT_FORWARD_UDP</code> |
| Default | <code>[]</code> |