> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rigbox.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# rig init

> Scaffold a rig.yaml for the current directory

Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`).

Scaffolds `rig.yaml` for the current directory. The app name comes from `--name`, or from the directory name, and is converted to lowercase letters, digits, and dashes (at most 48 characters) so that `rig deploy` accepts it. An existing `rig.yaml` is kept unless you pass `--force`.

## Examples

From your application directory, scaffold rig.yaml and review it before deploying.

```bash theme={null}
rig init
```

Name the app and its port. This writes `name: my-app`.

```bash theme={null}
rig init --name "My App" --port 8080
```

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

```bash theme={null}
rig init --help
```

## Local syntax

```text theme={null}
Usage: rigbox init [OPTIONS]
```

### Arguments and flags

| Argument | Description | Details |
| - | - | - |
| `--from` | Directory to scaffold (defaults to current directory) | Value: FROM |
| `-n, --name` | Override the app name (defaults to the directory name); converted to lowercase letters, digits and dashes | Value: NAME |
| `-p, --port` | Port to expose | Value: PORT; Default: 3000 |
| `--force` | Overwrite an existing rig.yaml | 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**
>
> ```text theme={null}
> Scaffold a rig.yaml for the current directory
>
> Usage: rigbox init [OPTIONS]
>
> Options:
>       --from <FROM>
>           Directory to scaffold (defaults to current directory)
>
>       --output <OUTPUT>
>           Output format [default: human, or `rig config set output …`]
>
>           [possible values: human, json, yaml, text, table]
>
>   -n, --name <NAME>
>           Override the app name (defaults to the directory name); converted to lowercase letters, digits and dashes
>
>       --query <JMESPATH>
>           Filter output with a JMESPath expression
>
>       --cli-input-json <FILE>
>           Read inputs from a JSON file or '-' (stdin)
>
>   -p, --port <PORT>
>           Port to expose
>
>           [default: 3000]
>
>       --cli-input-yaml <FILE>
>           Read inputs from a YAML file or '-' (stdin)
>
>       --force
>           Overwrite an existing rig.yaml
>
>       --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

```text theme={null}
Usage: rigbox init [OPTIONS]
```

### Arguments and flags

| Argument | Description | Details |
| - | - | - |
| `--from` | Directory to scaffold (defaults to current directory) | Value: FROM |
| `-n, --name` | Override the app name (defaults to the directory name); converted to lowercase letters, digits and dashes | Value: NAME |
| `-p, --port` | Port to expose | Value: PORT; Default: 3000 |
| `--force` | Overwrite an existing rig.yaml | 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**
>
> ```text theme={null}
> Scaffold a rig.yaml for the current directory
>
> Usage: rigbox init [OPTIONS]
>
> Options:
>       --from <FROM>
>           Directory to scaffold (defaults to current directory)
>
>       --output <OUTPUT>
>           Output format [default: human, or `rig config set output …`]
>
>           [possible values: human, json, yaml, text, table]
>
>   -n, --name <NAME>
>           Override the app name (defaults to the directory name); converted to lowercase letters, digits and dashes
>
>       --query <JMESPATH>
>           Filter output with a JMESPath expression
>
>       --no-pager
>           Do not pipe help output through a pager
>
>   -p, --port <PORT>
>           Port to expose
>
>           [default: 3000]
>
>       --force
>           Overwrite an existing rig.yaml
>
>   -v, --verbose
>           Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status)
>
>   -h, --help
>           Print help
> ```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.