rig app new

Available local and workspace. Reference source: CLI 0.13.0-rc.5 (824aefd6ad16). Registers an app for a port in a workspace. Without --workspace, it uses the workspace the CLI runs in, or on your laptop the workspace this directory’s rig.yaml deploys to (its .rig.lock binding). Put code on it with rig deploy.

Examples

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

rig app new --name my-project

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

rig app new --help

Local syntax

Usage: rigbox app new [OPTIONS] --name <NAME>

Arguments and flags

Argument	Description	Details
`-n, --name`	App name	Required; Value: NAME
`-p, --port`	Port the app listens on (default: 3000 for service apps; omit for cli apps)	Value: PORT
`-k, --kind`	App kind	Value: KIND; Default: service; Choices: service, cli
`-w, --workspace`	Workspace name or id (default: current rig.yaml workspace)	Value: WORKSPACE
`-d, --description`	App description	Value: DESCRIPTION
`--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

Create a new app in a workspace

Usage: rigbox app new [OPTIONS] --name <NAME>

Options:
  -n, --name <NAME>
          App name

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

  -p, --port <PORT>
          Port the app listens on (default: 3000 for service apps; omit for cli apps)

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

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

  -k, --kind <KIND>
          App kind
          
          [default: service]
          [possible values: service, cli]

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

  -w, --workspace <WORKSPACE>
          Workspace name or id (default: current rig.yaml workspace)

  -d, --description <DESCRIPTION>
          App description

      --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 new [OPTIONS] --name <NAME>

Arguments and flags

Argument	Description	Details
`-n, --name`	App name	Required; Value: NAME
`-p, --port`	Port the app listens on (default: 3000 for service apps; omit for cli apps)	Value: PORT
`-k, --kind`	App kind	Value: KIND; Default: service; Choices: service, cli
`-d, --description`	App description	Value: DESCRIPTION
`--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

Create a new app in this workspace

Usage: rigbox app new [OPTIONS] --name <NAME>

Options:
  -n, --name <NAME>
          App name

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

  -p, --port <PORT>
          Port the app listens on (default: 3000 for service apps; omit for cli apps)

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

  -k, --kind <KIND>
          App kind
          
          [default: service]
          [possible values: service, cli]

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

  -d, --description <DESCRIPTION>
          App description

  -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