Get started

A small, governed first step.

The quickest useful path is one accepted artifact, one consumer citation, and one visible stale dependency after a change. The commands below use the current supported CLI version, read from the package release metadata at build time.

1 · Install in your repository

The CLI starts with a small kernel. Templates and schemas are available on demand; expand the layout only when it helps your team.

npm install --save-dev --save-exact @prodshape/cli@0.22.1
npx --no-install prodshape init
npx --no-install prodshape validate
npx --no-install prodshape change create CHG-INITIAL

2 · Propose the initial definition

Add your first artifacts under the active CHG-INITIAL change, list them in its operations, and validate the proposal. Review its meaning with the people who know the product.

3 · Apply and accept through review

After a human marks the change approved, apply it on a working branch and open a pull request. The merge accepts the baseline; applying is not acceptance.

4 · Cite the definition in delivery work

Store the citation next to the consumer text it grounds. Change the accepted artifact in a later Product Change and verification will report the recorded citation as stale.

prodshape inspect ACT-USER
prodshape cite --id ACT-USER --digest <digest>
prodshape citations verify

Commands and capabilities present only on the repository's main branch may be newer than this published package.

Adoption guides

Choose the path that fits your product.

Start with a new product, recover what an existing one has taught you, or add ProductShape safely to a repository that already has its own tools and conventions.

  1. NEW PRODUCT →Start a new product

    Create the first product definition and accept it through the same review process used for later changes.

  2. EXISTING PRODUCT →Recover a product model from evidence

    Use documentation, tests, conversations, and other evidence to propose and review a model for a product already in use.

  3. EXISTING REPOSITORY →Add ProductShape to an existing repository

    See what initialization changes, what stays under your control, and how to configure ProductShape.