rig workspace start

Available local and workspace. Reference source: CLI 0.13.0-rc.5 (824aefd6ad16). Use this command from your local terminal. Once the workspace is running, it also sets up SSH access from this machine and prints the short ssh alias next to the full command. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop.

Examples

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

rig workspace start --workspace WORKSPACE_ID

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

rig workspace start --help

Local syntax

Usage: rigbox workspace start [OPTIONS] --workspace <WORKSPACE>

Arguments and flags

Argument	Description	Details
`-w, --workspace`	Workspace name or id	Required; Value: WORKSPACE
`--wait-for-apps`	Wait until workspace apps become active	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

Start a workspace

Usage: rigbox workspace start [OPTIONS] --workspace <WORKSPACE>

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

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

      --wait-for-apps
          Wait until workspace apps become active

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

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

      --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 workspace start [OPTIONS] --workspace <WORKSPACE>

Arguments and flags

Argument	Description	Details
`-w, --workspace`	Workspace name or id	Required; Value: WORKSPACE
`--wait-for-apps`	Wait until workspace apps become active	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

Start a workspace

Usage: rigbox workspace start [OPTIONS] --workspace <WORKSPACE>

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

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

      --wait-for-apps
          Wait until workspace apps become active

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

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

  -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