pkgcli

Documentation

Overview

Package pkgcli is the importable command surface of the v-pkg domain (the `v pkg` KIDS tool). It is exported so the `v` umbrella can mount it in-process as `v pkg <verb>` (static-pinned composition, v-cli-platform §3) while the standalone `v-pkg` binary embeds the same Commands for top-level verbs. The offline verbs (decompose / assemble / roundtrip / canonicalize / parse / lint) are the byte-identical port of py-kids-vc / XPDK2VC; the live KIDS lifecycle (build / install / verify / uninstall / status) lands in M0a's later tasks.

Index

• Constants
• func Contract() vcontract.Manifest
• type Commands

Constants

const (
	// Version is the declared SemVer of the v-pkg domain surface. It is a
	// committed constant (distinct from the link-time build version reported by
	// `version`) so the generated contract is drift-stable.
	Version = "0.3.0"

	// ContractVersion bumps only on an incompatible command-surface change
	// (v-cli-platform.md §4), independent of Version.
	ContractVersion = "1.0"
)

Functions

func Contract

func Contract() vcontract.Manifest

Contract returns the v-pkg domain contract manifest, reflected from the actual pkgcli command tree. It is what the standalone `v-pkg` writes to dist/v-contract.json and what the `v` umbrella aggregates into its registry — one source, so the manifest can never drift from the real verbs.

Types

type Commands

type Commands struct {
	Parse        parseCmd        `cmd:"" group:"Inspect" help:"Parse a .KID file and summarize its builds and sections."`
	Decompose    decomposeCmd    `cmd:"" group:"Transform" help:"Split a .KID into a per-component KIDComponents/ tree."`
	Assemble     assembleCmd     `cmd:"" group:"Transform" help:"Reassemble a component tree back into a .KID."`
	Roundtrip    roundtripCmd    `cmd:"" group:"Transform" help:"Verify decompose→assemble reproduces the build (exit 3 on drift)."`
	Canonicalize canonicalizeCmd `cmd:"" group:"Transform" help:"Substitute install-time IENs with \"IEN\" in a tree (LOSSY; review-only)."`
	Classify     classifyCmd     `` /* 134-byte string literal not displayed */
	Lint         lintCmd         `cmd:"" group:"Inspect" help:"Run the PIKS data-class gate over a .KID (exit 3 on a blocked file)."`
	Build        buildCmd        `` /* 133-byte string literal not displayed */
	Install      installCmd      `` /* 128-byte string literal not displayed */
	Snapshot     snapshotCmd     `cmd:"" group:"Back-out" help:"Capture the live pre-image of a patch's routines into a restorable .KID (class-1 reversal)."`
	Restore      restoreCmd      `` /* 134-byte string literal not displayed */
	Verify       verifyCmd       `cmd:"" group:"Build & install" help:"Verify a .KID's install on a live engine (#9.7 status + per-routine presence)."`
	Uninstall    uninstallCmd    `cmd:"" group:"Back-out" help:"Uninstall a .KID from a live engine (routine-only back-out: routines + #9.7/#9.6)."`
}

Commands is the v-pkg verb set. Embed it (anonymous) for top-level verbs in the standalone binary, or mount it as a named field (`Pkg Commands` with cmd:"" name:"pkg") under the `v` umbrella for `v pkg <verb>`.