Skip to content

Commit cfd5652

Browse files
committed
clarify CLI docs and smoke command
1 parent 1f30b05 commit cfd5652

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,5 @@ Use conventional commit format:
3535

3636
## Local Smoke Check
3737
```bash
38-
node ./bin/create-shape-app.js my-app --yes --skip-git
38+
node ./bin/create-shape-app.js my-app --yes --skip-install --skip-git
3939
```

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,13 @@ Options:
2929
- `--skip-install`
3030
- `--skip-git`
3131
- `--template-ref <tag>`
32+
- `-h, --help`
33+
- `-v, --version`
3234

3335
## Behavior
3436
- Scaffolds from `shape-network/builder-kit` release tags only (`latest` by default).
3537
- Rejects non-release refs (for example `main`) and canary tags.
38+
- In non-interactive terminals, `--yes` is required.
3639
- Copies template files, excluding VCS/internal maintainer metadata.
3740
- Applies defaults:
3841
- Root `package.json` name is set from the project directory name.

0 commit comments

Comments
 (0)