# docs-init

Adopt the Megamono docs, agents, and skills modules


## When to use it

Adopt the Megamono docs, agents, and skills modules. Use this when you want to add the corresponding files or task to your workspace.

## Usage

```sh
npm exec -- nx generate @megamono/plugin:docs-init --dry-run
```

Replace angle-bracket placeholders with reviewed values. Nx's `--dry-run` previews generator writes; remove it only after reviewing the plan. Examples use npm; use your workspace's package manager if it differs.

## Options

Use these options with `@megamono/plugin:docs-init`. 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 |
| --- | --- | --- | --- | --- |
| `docsRoot` | No | string | "docs" | — |
| `defaultScope` | No | string | "shared" | — |
| `survey` | No | boolean | false | Print the deterministic workspace survey and exit without mutation. |
| `format` | No | string | "markdown" | — Allowed: "markdown", "json". |
| `yes` | No | boolean | false | Apply the focused non-interactive plan. |
| `report` | No | string | — | Workspace-relative path for the optional completion report. |

## 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 generators](/docs/generators)
- [CLI overview](/docs/cli)
- [Adopt an existing workspace](/docs/workflows/adoption)
