简体中文

Quickstart

This page gives each of three reader types a shortest path to success: new projects, existing projects, and architecture designers. Each path lists only the required actions and verification commands; follow the corresponding documentation for deeper detail.

New Project: Generate a Skeleton

The goal is to obtain a Foundation-compliant project skeleton from scratch.

npm install --save-dev skill-family-engineering-kit
npm exec -- skill-family-kit scaffold --root ./my-project --project-id my-project
npm exec -- skill-family-kit check --root ./my-project

The commands above first generate a skeleton, then run engineering diagnostics on the generated result. scaffold writes only to an empty target directory; a non-empty or conflicting target is refused and not touched; check diagnoses only, it does not fix. Verification passes when check exits with code 0.

Existing Project: Read-Only Inventory

The goal is to first see whether the existing repository can be adopted, without changing any bytes.

npm exec -- skill-family-kit adopt-plan --root ./existing-repo
npm exec -- skill-family-kit check --root ./existing-repo

adopt-plan outputs the current state, target Profile, exact write set, conflicts, and the legacy-implementation exit list, with zero change to the input repository's bytes. check performs read-only diagnostics only. Decide whether to perform a write after confirming the inventory results.

Architecture Designer: Decide Ownership

The goal is to determine which Foundation layer an architecture requirement should land in, or whether it should stay with the consumer.

1. Read the eight-step decision order in docs/agents/architecture-routing.md.
2. In docs/agents/capability-catalog.json, find the capability by layer and intent, and read its entrypoints, sideEffects, failureSemantics, ownedByCaller.
3. When publishing, task lifecycle, or artifact relationships are involved, route to release-skill, loop-agent, and artifact-graph respectively.

The hard boundary of routing: Foundation does not own remote writes, business state machines, model orchestration, or domain-audit semantics. Capabilities that fall into keep-business or foundation-gap do not forcibly expand Foundation.

Authoritative Facts and Specifications

• Current product status (versions, package set, mirror coordinates, gates): Current Product Status (the single status page; not duplicated here).
• Development and commit specifications: Git Lifecycle Guide.

Path Reference

Reader	Starting point	Next step
New project	scaffold	check → integrate Profile
Existing project	adopt-plan	classify (direct-adoption / compatibility-layer / keep-business / foundation-gap) → adopt
Architecture designer	routing decision	capability catalog → real exports and tests