New
The Gartner Hype Cycle Emerging Technologies Report is out!

Download now

Home
/
Command Line
/
port-forward

port-forward

port-forward

Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R".

Aliases:

  • tunnel

Usage

coder port-forward [flags] <workspace>

Description

  - 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

  - Port forward specifying the local address to bind to:

     $ coder port-forward <workspace> --tcp 1.2.3.4:8080:8080

Options

--disable-autostart

Typebool
Environment$CODER_SSH_DISABLE_AUTOSTART
Defaultfalse

Disable starting the workspace automatically when connecting via SSH.

-p, --tcp

Typestring-array
Environment$CODER_PORT_FORWARD_TCP

Forward TCP port(s) from the workspace to the local machine.

--udp

Typestring-array
Environment$CODER_PORT_FORWARD_UDP

Forward UDP port(s) from the workspace to the local machine. The UDP connection has TCP-like semantics to support stateful UDP protocols.

See an opportunity to improve our docs? Make an edit.