Skip to content

Commit 6c79fa5

Browse files
authored
docs(cli): document create opt-out options (#1790)
## Summary `vp create` help and docs now show the supported agent/editor opt-out flags, so users can discover `--no-agent` and `--no-editor` without relying on examples or implementation details. The create guide also documents `--package-manager`, matching the option already exposed in CLI help.
1 parent a03f569 commit 6c79fa5

4 files changed

Lines changed: 13 additions & 0 deletions

File tree

docs/guide/create.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,14 @@ Run `vp create --list` to see the built-in templates and the common shorthand te
4444

4545
- `--directory <dir>` writes the generated project into a specific target directory
4646
- `--agent <name>` creates agent instructions files during scaffolding
47+
- `--no-agent` skips agent instruction setup
4748
- `--editor <name>` writes editor config files
49+
- `--no-editor` skips editor config setup
4850
- `--git` initialize a git repository
4951
- `--no-git` skips git repository initialization
5052
- `--hooks` enables pre-commit hook setup
5153
- `--no-hooks` skips hook setup
54+
- `--package-manager <name>` uses a specified package manager (`pnpm`, `npm`, `yarn`, or `bun`)
5255
- `--no-interactive` runs without prompts
5356
- `--verbose` shows detailed scaffolding output
5457
- `--list` prints the available built-in and popular templates

packages/cli/snap-tests-global/command-create-help/snap.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Arguments:
1616
Options:
1717
--directory DIR Target directory for the generated project.
1818
--agent NAME Write coding agent instructions to AGENTS.md, CLAUDE.md, etc.
19+
--no-agent Skip writing coding agent instructions
1920
--editor NAME Write editor config files for the specified editor.
21+
--no-editor Skip writing editor config files
2022
--git Initialize a git repository with an initial commit
2123
--no-git Skip git repository initialization
2224
--hooks Set up pre-commit hooks (default in non-interactive mode)
@@ -79,7 +81,9 @@ Arguments:
7981
Options:
8082
--directory DIR Target directory for the generated project.
8183
--agent NAME Write coding agent instructions to AGENTS.md, CLAUDE.md, etc.
84+
--no-agent Skip writing coding agent instructions
8285
--editor NAME Write editor config files for the specified editor.
86+
--no-editor Skip writing editor config files
8387
--git Initialize a git repository with an initial commit
8488
--no-git Skip git repository initialization
8589
--hooks Set up pre-commit hooks (default in non-interactive mode)
@@ -142,7 +146,9 @@ Arguments:
142146
Options:
143147
--directory DIR Target directory for the generated project.
144148
--agent NAME Write coding agent instructions to AGENTS.md, CLAUDE.md, etc.
149+
--no-agent Skip writing coding agent instructions
145150
--editor NAME Write editor config files for the specified editor.
151+
--no-editor Skip writing editor config files
146152
--git Initialize a git repository with an initial commit
147153
--no-git Skip git repository initialization
148154
--hooks Set up pre-commit hooks (default in non-interactive mode)

packages/cli/snap-tests-global/new-check/snap.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Arguments:
1616
Options:
1717
--directory DIR Target directory for the generated project.
1818
--agent NAME Write coding agent instructions to AGENTS.md, CLAUDE.md, etc.
19+
--no-agent Skip writing coding agent instructions
1920
--editor NAME Write editor config files for the specified editor.
21+
--no-editor Skip writing editor config files
2022
--git Initialize a git repository with an initial commit
2123
--no-git Skip git repository initialization
2224
--hooks Set up pre-commit hooks (default in non-interactive mode)

packages/cli/src/create/bin.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,12 @@ const helpMessage = renderCliDoc({
113113
label: '--agent NAME',
114114
description: 'Write coding agent instructions to AGENTS.md, CLAUDE.md, etc.',
115115
},
116+
{ label: '--no-agent', description: 'Skip writing coding agent instructions' },
116117
{
117118
label: '--editor NAME',
118119
description: 'Write editor config files for the specified editor.',
119120
},
121+
{ label: '--no-editor', description: 'Skip writing editor config files' },
120122
{ label: '--git', description: 'Initialize a git repository with an initial commit' },
121123
{ label: '--no-git', description: 'Skip git repository initialization' },
122124
{

0 commit comments

Comments
 (0)