@uinaf/workspace-kit

workspace-kit

Config-driven validation and scaffolding for agent workspaces — the git repositories that give coding/assistant agents a stable operating context. Not related to npm/yarn/pnpm workspaces or monorepo tooling.

Install

npm install -D @uinaf/workspace-kit

Or run one-shot with npx -y @uinaf/workspace-kit. Requires Node >= 24.18, plus git on PATH for the history-dependent checks. Pin exact versions.

Quick usage

npx -y @uinaf/workspace-kit init --profile personal   # scaffold a workspace
npx -y @uinaf/workspace-kit doctor                    # validate it
npx -y @uinaf/workspace-kit registry validate         # validate projects.json

doctor runs every repository-state check the workspace declares in its workspace.json — structure, wiki hygiene, ownership contracts, documentation links, and size limits. Candidate paths are screened separately with contract handoff <paths...> because passing that gate means only "eligible for human review." Absent config sections disable their checks, unknown files are always tolerated, and everything runs offline with zero runtime dependencies. workspace-kit --help lists all commands.

registry validate is an explicit project-registry gate. It validates the entire declared entry shape before inspecting any locally present checkout, then checks project paths against the configured home-relative prefix, GitHub origins, portable case/Unicode aliases, canonical roots, and optional catalog pointers. The explicit registry.project policy enables this command; missing checkouts are allowed. Personal and runtime scaffolds include this gate in their generated pre-commit hook and validation instructions.

Docs

• Workspace convention and check contracts — what an agent workspace is and exactly what each check enforces
• Parity oracle — the executable spec the checks are held to, byte-for-byte
• Release workflow — automatic, tokenless publishing

Contributing

See CONTRIBUTING.md. Vulnerabilities: SECURITY.md.

License

MIT