pdd-kit blueprint open
Expand a Blueprint file you were
given into a product-model/ Product Model. For a published Blueprint, use
blueprint pull instead.
npx @itai-gendler/pdd-kit blueprint open <report> [--force]
Options
| Option | Meaning |
|---|---|
<report> | Path to a local Product Report file, resolved from your shell's directory, not from --cwd. A URL is refused |
--force | Move a non-empty product-model/ aside to a backup first |
--cwd picks the directory that receives product-model/; it need not be a Git
repository:
npx @itai-gendler/pdd-kit --cwd ./new-product blueprint open ./report.json
What it does
- Reads the file: a regular file, not a link, at most 8 MiB.
- Validates it as a Product Report and applies the portable projection.
- Writes the model, with its orientation
README.md, into a temporaryproduct-model-open-*directory beside the target, and lints it there. - Moves it into place as
product-model/and removes the temporary directory.
Everything except repository navigation comes through (see
what export keeps). Coverage comes through
empty: no code in your repository has been mapped to the model yet. A report
carries no logo or cover, so the Product is written compact, as
product.md.
Safety
A non-empty product-model/ is refused unless you pass --force, which first
renames it to a product-model.backup-<timestamp>/ sibling that is never
deleted. A product-model that is a link or a file is always refused. Nothing is
written to the target until the expanded model lints.
Exits 0 when the model is written, 1 when the file or the target is refused, and 2 when given a URL or invalid options.
Next
- Start from a Blueprint to review, adapt and implement it.