rig app expose-port

Available local and workspace. Reference source: CLI 0.13.0-rc.5 (824aefd6ad16). Use this command from your local terminal or inside a workspace. Inside a workspace, --workspace defaults to that workspace. --name without --wrap asks before creating the app route; where it cannot ask (no terminal, JSON output, or CI) it refuses and names --wrap. Pass --wrap --name NAME to create the route, or leave out both to only detect the listener.

Examples

Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.

rig app expose-port --workspace WORKSPACE_ID --port 3000

Inspect the supported arguments before running this command. Help is offline and does not modify resources.

rig app expose-port --help

Local syntax

Usage: rigbox app expose-port [OPTIONS] --workspace <WORKSPACE> --port <PORT>

Arguments and flags

Argument	Description	Details
`-w, --workspace`	Workspace name or id	Required; Value: WORKSPACE
`-p, --port`	Port to detect or expose	Required; Value: PORT
`-n, --name`	App name to use when wrapping the port	Value: NAME
`--wrap`	Create the app route instead of only detecting the process	Default: false
`--output`	Output format [default: human, or `rig config set output …`]	Global; Value: OUTPUT; Choices: human, json, yaml, text, table
`--query`	Filter output with a JMESPath expression	Global; Value: JMESPATH
`--cli-input-json`	Read inputs from a JSON file or ’-’ (stdin)	Global; Value: FILE
`--cli-input-yaml`	Read inputs from a YAML file or ’-’ (stdin)	Global; Value: FILE; Conflicts: cli_input_json
`--generate-cli-skeleton`	Print a fillable input template, then exit	Global; Default: false
`--no-pager`	Do not pipe help output through a pager	Global; Default: false
`-v, --verbose`	Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`	Global; Default: false
`-h, --help`	Print help

Complete command help

Detect or expose a workspace port as an app

Usage: rigbox app expose-port [OPTIONS] --workspace <WORKSPACE> --port <PORT>

Options:
      --output <OUTPUT>
          Output format [default: human, or `rig config set output …`]
          
          [possible values: human, json, yaml, text, table]

  -w, --workspace <WORKSPACE>
          Workspace name or id

  -p, --port <PORT>
          Port to detect or expose

      --query <JMESPATH>
          Filter output with a JMESPath expression

      --cli-input-json <FILE>
          Read inputs from a JSON file or '-' (stdin)

  -n, --name <NAME>
          App name to use when wrapping the port

      --cli-input-yaml <FILE>
          Read inputs from a YAML file or '-' (stdin)

      --wrap
          Create the app route instead of only detecting the process

      --generate-cli-skeleton
          Print a fillable input template, then exit

      --no-pager
          Do not pipe help output through a pager

  -v, --verbose
          Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`

  -h, --help
          Print help

Workspace syntax

Usage: rigbox app expose-port [OPTIONS] --port <PORT>

Arguments and flags

Argument	Description	Details
`-w, --workspace`	Workspace name or id (default: this workspace)	Value: WORKSPACE
`-p, --port`	Port to detect or expose	Required; Value: PORT
`-n, --name`	App name to use when wrapping the port	Value: NAME
`--wrap`	Create the app route instead of only detecting the process	Default: false
`--output`	Output format [default: human, or `rig config set output …`]	Global; Value: OUTPUT; Choices: human, json, yaml, text, table
`--query`	Filter output with a JMESPath expression	Global; Value: JMESPATH
`--no-pager`	Do not pipe help output through a pager	Global; Default: false
`-v, --verbose`	Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status)	Global; Default: false
`-h, --help`	Print help

Complete command help

Detect or expose a workspace port as an app

Usage: rigbox app expose-port [OPTIONS] --port <PORT>

Options:
      --output <OUTPUT>
          Output format [default: human, or `rig config set output …`]
          
          [possible values: human, json, yaml, text, table]

  -w, --workspace <WORKSPACE>
          Workspace name or id (default: this workspace)

  -p, --port <PORT>
          Port to detect or expose

      --query <JMESPATH>
          Filter output with a JMESPath expression

  -n, --name <NAME>
          App name to use when wrapping the port

      --no-pager
          Do not pipe help output through a pager

  -v, --verbose
          Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status)

      --wrap
          Create the app route instead of only detecting the process

  -h, --help
          Print help

Start here

Deploy applications

Configure applications

Workspaces and storage

AI and tools

Operate and troubleshoot

Examples

CLI reference

Build on Rigbox

Examples

Local syntax

Arguments and flags

Workspace syntax

Arguments and flags

​Examples

​Local syntax

​Arguments and flags

​Workspace syntax

​Arguments and flags

Examples

Local syntax

Arguments and flags

Workspace syntax

Arguments and flags