@skill-map/cli 0.17.0 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -78,6 +78,10 @@ Exit codes follow [`spec/cli-contract.md`](../spec/cli-contract.md):
78
78
  | `4` | Nonce mismatch |
79
79
  | `5` | Resource not found |
80
80
 
81
+ ## Sidecar `.sm` files
82
+
83
+ `sm bump` and `sm sidecar annotate` write a sibling `<basename>.sm` YAML next to each `.md` (same directory). Their purpose is to keep skill-map's bookkeeping — version, stability, supersession, tags, audit trail — **out of the `.md` body and frontmatter**. The `.md` stays vendor-pure (Claude Code, Codex, Cursor, …); the `.sm` is the only file skill-map writes. **`sm scan`, `sm watch`, and the live UI never create `.sm` files** — they only read existing ones; sidecars appear only when you opt in via `bump` or `annotate`. **Commit `.sm` files to git like any other source file** — don't `.gitignore` them; they carry the metadata that drives `sm check`, drift detection, and supersession graphs. Full spec: [`spec/architecture.md` §Annotation system](../spec/architecture.md#annotation-system).
84
+
81
85
  ## Spec
82
86
 
83
87
  This binary implements the [skill-map spec](https://www.npmjs.com/package/@skill-map/spec). The spec package ships JSON Schemas, conformance cases, and prose contracts; `skill-map` conforms to a declared range via its `specCompat`.
@@ -863,6 +863,13 @@ Mark `2-ui-live: done`.
863
863
  > UI sees it instantly. In **~10 minutes** you've already seen the
864
864
  > full flow.
865
865
  >
866
+ > ⚠️ **`.sm` files (heads-up for later)** — when skill-map needs to
867
+ > record metadata on a node, it doesn't modify the `.md` directly;
868
+ > it creates a sibling file with `.sm` extension (e.g. `demo-agent.sm`
869
+ > next to `demo-agent.md`). You won't see any during this demo — they
870
+ > only appear after `sm bump` or `sm sidecar annotate`. Commit them
871
+ > to git like any other source file.
872
+ >
866
873
  > If you want, **we can keep going deeper**: I'll walk you through
867
874
  > the CLI verbs and flags (`list`, `graph`, `export`, `orphans`,
868
875
  > `plugins`, `db ops`, etc.). About ~20-30 min more, pausable