Files
coder/docs/cli/coder_port-forward.md
2023-02-23 01:53:21 +00:00

54 lines
1.2 KiB
Markdown

<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder port-forward
Forward ports from machine to a workspace
## Usage
```console
coder port-forward <workspace> [flags]
```
## Examples
```console
- Port forward a single TCP port from 1234 in the workspace to port 5678 on
your local machine:
$ coder port-forward <workspace> --tcp 5678:1234
- Port forward a single UDP port from port 9000 to port 9000 on your local
machine:
$ coder port-forward <workspace> --udp 9000
- Port forward multiple TCP ports and a UDP port:
$ coder port-forward <workspace> --tcp 8080:8080 --tcp 9000:3000 --udp 5353:53
- Port forward multiple ports (TCP or UDP) in condensed syntax:
$ coder port-forward <workspace> --tcp 8080,9000:3000,9090-9092,10000-10002:10010-10012
```
## Flags
### --tcp, -p
Forward TCP port(s) from the workspace to the local machine.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PORT_FORWARD_TCP</code> |
| Default | <code>[]</code> |
### --udp
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> |