coder/docs/reference/cli/port-forward.md at 2ee96f82f947a14861956c18fdd957a439b8a671

mirror of https://github.com/coder/coder.git synced 2026-10-16 14:48:56 +08:00

Files

T

Nick Vigilante 2ee96f82f9 docs: give every table header cell text and fail lint on empty ones

Screen readers announce a table header cell with no text as an unnamed
column, and axe reports it as empty-table-header.

- clidocgen writes "Property | Value" over each option's metadata table
  instead of an empty header row; the CLI reference is regenerated.
- The port-forwarding CORS matrix labels its corner cells (From user,
  From workspace, To user, To workspace, To app).
- Four Markdown matrices get a corner label, byte-identical to #30873.
- docshtmlcheck (make lint/docs-html) now fails on empty header cells in
  Markdown pipe tables and raw HTML tables, naming the file, line, and
  the table's first header.

Assisted-by: AI

2026-10-15 16:48:16 -04:00

2.2 KiB

Generated

Raw Blame History

title, description

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

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

-p, --tcp

Property	Value
Type	`string-array`
Environment	`$CODER_PORT_FORWARD_TCP`

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

--udp

Property	Value
Type	`string-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.

--disable-autostart

Property	Value
Type	`bool`
Environment	`$CODER_SSH_DISABLE_AUTOSTART`
Default	`false`

Disable starting the workspace automatically when connecting via SSH.

2.2 KiB Generated Raw Blame History