Skip to content

Commit 797c45a

Browse files
committed
docs(installer): clarify --preset vs --config in README
1 parent ac7dd3e commit 797c45a

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,18 +57,20 @@ create-viterex [project-name] [options]
5757

5858
### Options
5959

60+
> **`--preset` vs `--config`?** A **preset** is a starting point — it pre-fills addon selection, layout, seed SQL, and template files, but you'll still answer prompts for everything not covered (project name, DB, admin user, etc.). A **config file** (the JSON written by `--generate-config`) pins *every* answer; passing `--config` skips all prompts entirely. Use `--preset` interactively, `--config` for CI.
61+
6062
| Flag | Description | Default |
6163
| -------------------- | -------------------------------------------------------------------- | ---------------- |
6264
| `--skip-db` | Skip database creation (assume pre-populated empty DB at credentials) | `false` |
6365
| `--skip-addons` | Skip addon installation | `false` |
6466
| `--skip-git` | Don't initialize a git repo | `false` |
65-
| `--pm <manager>` | Package manager: `yarn`, `npm`, or `pnpm` | `pnpm` |
66-
| `--preset <name>` | Preset (`default`, `massif`, `custom`, or path to `preset.json`) | prompted |
67-
| `--config <path>` | Load config from a JSON file (skip all prompts) | |
67+
| `--pm <manager>` | Package manager used to install JS deps after Redaxo is set up | `pnpm` |
68+
| `--preset <name>` | Built-in id (`default`, `massif`, `custom`) or path to a preset directory or `preset.json` | prompted |
69+
| `--config <path>` | Path to a previously-generated `viterex.json` (or directory containing one); skips all prompts ||
6870
| `--resume` | Resume a previously failed run, skipping completed tasks | `false` |
6971
| `--dry-run` | Log each task without executing anything | `false` |
7072
| `--verbose` | Pipe task stdout/stderr to the terminal | `false` |
71-
| `--layout <m|c|ct>` | Directory layout: `modern`, `classic`, `classic+theme` | prompt (modern) |
73+
| `--layout <m|c|ct>` | Directory layout: `modern` (ydeploy, recommended), `classic` (Redaxo defaults), `classic+theme` (FriendsOfREDAXO/theme) | prompt (modern) |
7274
| `--fresh` | Force fresh-install pipeline even when an existing Redaxo is detected | `false` |
7375
| `--force-push` | Allow `git push --force` when the remote already has commits | `false` |
7476
| `--with-tower` | macOS only. Bypass the prompt and force-open Tower after a successful run. Skipped when the preset sets `withTower: false`. | prompted on macOS when `gittower` is on PATH |

0 commit comments

Comments
 (0)