# Laravel setup

Materialize the official Laravel skeleton into a reviewed generated project


## When to use it

Materialize the official Laravel skeleton into a reviewed generated project. Use this when you want to add the corresponding files or task to your workspace.

## Usage

Configure an Nx target on the owning project, then invoke it with `npm exec -- nx run <project>:<target>`. The executor identifier is not a standalone CLI command.

```json
{
  "targets": {
    "reviewed-action": {
      "executor": "@megamono/nx-laravel:setup",
      "options": {
        "root": "<root>"
      }
    }
  }
}
```

This target is a configuration example. Supply required values and review side effects before invoking it.

## Options

Use these options with `@megamono/nx-laravel:setup`. Nx uses the camelCase names shown here; the [CLI reference](/docs/cli) describes command-line aliases. Some options are required only for particular choices.

| Option | Required | Type | Default | Description |
| --- | --- | --- | --- | --- |
| `root` | Yes | string | — | — |

## Next steps

Review changed files and run the affected project's checks. For options that accept structured values, run the generator's `--help` or consult the schema in the installed package.

- [All actions](/docs/actions)
- [CLI overview](/docs/cli)
- [Adopt an existing workspace](/docs/workflows/adoption)