Packages

Packages ▣

A package is a self-contained directory with a manifest.

my-package/
  zinc.pkg.yaml
  software/
  settings/
  shapes/
  docs/

Zinc records package identity and root. It does not catalog the package internals.

◌ What Zinc records

name
version
root
source.git
source.ref
source.path

Those are the package facts Zinc keeps.

✦ What the package owns

software
settings
docs
shapes
commands
scripts

Those are package-owned paths.

Zinc does not give them native meaning.

▣ Example manifest

name: unix-bash
version: "0.1.0"
about: Unix Bash command package.

source:
  git: https://github.com/darkhorseprojects/darkhorseprojects-packages.git
  ref: unix-bash-v0.1.0
  path: unix-bash

software:
  run: software/run.py

settings:
  defaults: settings/defaults.yaml
  policy: settings/policy.yaml

docs:
  readme: docs/README.md

⟡ Navigation

zinc://packages/<package>/manifest/<path>
zinc://packages/<package>/files/<relative/path>

Examples:

zn read zinc://packages/unix-bash/manifest/software/run
zn read zinc://packages/unix-bash/files/software/run.py

manifest/<path> reads a manifest node. files/<relative/path> reads a package file.

Zinc does not guess that every manifest string is a file path.

↯ Commands

zn pkg install <package-dir> [--global|--workspace]
zn pkg remove <name>
zn pkg list
zn pkg check <name>
zn pkg update <name|--all> [--check]

Install and remove stay easy.

Zinc does not silently run package setup, check, or remove code.

✧ Read next

• Package Software
• Manifest Navigation