Skip to content
/patternsdocs
Getting started

Add your first pattern

Find, evaluate, install, and verify architecture guidance without generating source code.

1. Search by problem

Use natural technical terms, a target, or a known architecture name:

patterns find "replace database without coupling business logic"
patterns find "react feature folders"

The directory ranks matches on human titles, stable IDs, aliases, descriptions, categories, tags, technical facets, and the bundle's indexed guidance. Install count is only a tie-breaker.

2. Evaluate the result

Before installing, check:

  • the problem it solves and the cases where it should be avoided;
  • its language, runtime, and framework requirements;
  • how it relates to patterns already in the project;
  • the verified source owner and immutable version or commit you intend to use.

3. Add a pinned ref

patterns add owner/repo/path-to-pattern#pattern-name-v1.2.0

Pinning a tag or commit makes the installation reproducible. An unpinned default-branch ref can change between machines or dates, so the CLI asks for confirmation when it can.

4. Confirm the integration

patterns list
patterns check

Use patterns sync if agent-instruction files need to be repaired or regenerated. add, update, and remove already synchronize them automatically.

On this page