Packages

Packages

Zinc packages group reusable Circuitry 0.6 shapes and their supporting files.

Packages install into workspace .zinc/packages/ or global ~/.zinc/packages/ state and are indexed in Limbo.

Manifest

A package contains zinc.pkg.yaml:

name: browser
version: "0.1.0"
about: Browser action shapes.

shapes:
  observe: shapes/observe.circuitry.yaml
  input: shapes/input.circuitry.yaml

prompts:
  guidance: prompts/guidance.md

files:
  setup: scripts/setup.sh

source:
  git: https://git.example.org/team/browser.git
  ref: main
  path: .

scripts:
  check: scripts/check.sh

Keys

• name: package name.
• version: package version.
• about: short package description.
• shapes: named Circuitry shape files.
• prompts: supporting markdown prompts.
• files: supporting assets.
• source.git: optional provider-neutral git URL used by zn pkg update.
• source.ref: optional branch, tag, or commit. Defaults to main.
• source.path: optional package subdirectory inside the repository. Defaults to ..
• scripts: optional lifecycle scripts.

Updating

zn pkg update browser
zn pkg update --all
zn pkg update browser --check

Local packages without a source.git entry are skipped by update.

References

Installed package shapes can be resolved with:

zinc://package/<name>/shape/<shape>