unknown-knowledge 2.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,5 @@
+unknown-knowledge
+Copyright 2026 Unknown Creatives Studio
+
+This product includes software developed at Unknown Creatives Studio
+(https://github.com/doterodesign/unknown-knowledge).

package/README.md

@@ -0,0 +1,167 @@
+# unknown-knowledge
+
+A free, open-source CLI that stands up a self-improving knowledge base in any
+codebase, and a deterministic engine that keeps it honest.
+
+**The map is never the fact.** The stores hold claims and pointers; your source
+files hold the facts. The engine's only job is to diff the two and say exactly
+where they disagree — so an agent reading the knowledge base is reading
+something that was checked, not something somebody remembered.
+
+Nothing here is a service. There is no runtime, no daemon, no network call, and
+no update channel. Everything is YAML and JavaScript files in your repo,
+branched and merged by your normal PRs.
+
+## Quickstart
+
+```bash
+cd your-repo
+npx unknown-knowledge init          # seeds unknown-knowledge/ and an agent wrapper
+npm install --save-dev js-yaml      # the engine's one runtime dependency
+```
+
+Then run `/knowledge-bootstrap` in your coding agent. Phase 2 surveys the repo,
+proposes Anchor candidates, and you approve each Concept. Nothing is captured
+automatically — a fact nobody approved is a fact nobody checked.
+
+## What you get
+
+Three governed YAML stores, split by **truth anchor** — who is allowed to say a
+thing is true:
+
+| Store | Holds | Anchored to |
+| --- | --- | --- |
+| `ontology/` | what the system *is* | your source files |
+| `knowledge/` | what the team *knows* | cited evidence |
+| `decisions/` | what was *chosen*, and why | the team |
+
+An **Ontology Concept** names a closed set of values and points at the file that
+owns them. An **Extractor kind** re-derives that set by reading the file
+lexically, and the value validator diffs the two. When someone adds a case to an
+enum and forgets the store, the diff says so.
+
+Thirteen extractor kinds ship — across TypeScript, Swift, JSON, YAML,
+`.strings`, and newline-delimited lists. Twelve of them the survey map can
+propose for you by signature; the thirteenth is reachable only when a human
+names it, because "a file of lines" describes every text file ever written.
+
+They **refuse rather than guess**: a kind that meets a spread, a
+computed key, or a re-export barrel raises a hard error, because a confident
+wrong parse is a false all-clear. What it could not read is recorded in
+`logs/misses/` for a human to decide about.
+
+## The engine
+
+Ten command-line surfaces. JavaScript with JSDoc types, zero build step, one
+dependency (D-022).
+
+| Command | Answers |
+| --- | --- |
+| `validate.js` | is the store structurally sound? |
+| `validate-values.js` | do the Concepts still match the code they point at? |
+| `preflight.js` | which Concepts may this agent trust, right now? |
+| `resolve.js` | what does the store know about these terms or paths? |
+| `survey-map.js` | what is in this repo, and what could not be surveyed? |
+| `audit.js` | what looks like knowledge but was never written down? |
+| `log-entry.js` | append a finding, miss or gap — never by hand-editing YAML |
+| `ingest.js` | normalize a document (md, txt, html, pdf) to one intermediate representation |
+| `phoenix.js` | apply a phoenix event: re-file a drifted subtree in bulk, in full or not at all |
+| `derive.js` | regenerate the derived layer: plural browse trees, call numbers, resolution index |
+
+### Exit codes are a contract
+
+Every surface obeys the same three codes, and agents ride them:
+
+| Code | Means |
+| --- | --- |
+| `0` | the check ran and found nothing |
+| `1` | the check ran and **found something** |
+| `2` | the check **did not run** — an engine failure |
+
+The distinction between `1` and `2` is the load-bearing one. An agent that reads
+`1` quarantines the affected Concepts and continues. If a crashed command could
+exit `1`, that agent would walk straight past a check that never happened. So a
+crash always exits `2`, and a test enumerates every surface, forces a bug into
+each, and proves it.
+
+The reverse audit is advisory: its findings are proposals for human review, and
+never a gate. A human may opt in with `--fail-on-findings`, and that is never a
+shipped CI default.
+
+## Guarantees
+
+- **The engine never executes your code** (D-014). No `eval`, no importing your
+  modules, no spawning your build. Parsing is lexical; the one subprocess it
+  runs is `git ls-files`.
+- **No network, ever.** Nothing is uploaded, and nothing is fetched.
+- **Deterministic.** Same tree in, byte-identical output out. Dates are
+  injected, never read from the wall clock, so a report is reproducible from
+  its inputs.
+- **Nothing ships by omission** (D-007). An explicit manifest lists every file
+  `init` seeds; a file it does not name is never copied.
+
+## Hooks — the protocol, enforced mechanically
+
+Two POSIX-sh hooks seed under `hooks/`: `pre-commit` runs the blocking
+validator before a commit exists, and `reverse-lookup` runs the `--paths`
+lookup over your staged diff, so the knowledge governing the files you touched
+surfaces without anyone remembering to ask. Each is a thin wrapper — it invokes
+one engine command and exits with its code, unchanged — and neither reads a
+bypass variable, because a hook with an off switch enforces nothing.
+
+They **seed but do not install**: `init` never writes `.git/`, so wiring them is
+your act, not the kit's. Git runs a hook only if it is executable, and the copy
+engine seeds bytes rather than modes — so set the bit when you wire it:
+
+```sh
+chmod +x unknown-knowledge/hooks/*
+ln -s ../../unknown-knowledge/hooks/pre-commit .git/hooks/pre-commit
+ln -s ../../unknown-knowledge/hooks/reverse-lookup .git/hooks/prepare-commit-msg
+```
+
+Note the second symlink's name. Git runs a hook only if its filename is one of
+the events git fires, and `reverse-lookup` is not one of them —
+`prepare-commit-msg` runs after the index is staged and before the message
+editor opens, which is when attribution is still actionable. (Git passes that
+hook the message file and source as arguments; the script ignores them and
+reads the staged diff itself.) The same rule bites harder under
+`core.hooksPath` pointed at the seeded directory: git looks there for
+event-named files only, so `reverse-lookup` would sit beside `pre-commit` and
+never fire. Under that wiring, call it explicitly from your `pre-commit`.
+
+## Seeded once, then owned
+
+After `init`, the seeded directory has no relationship to this kit (D-001).
+There is no update channel and there never will be one. You own the engine, you
+can read it, and you can change it — it is JavaScript, not a binary.
+
+The seed stamps the kit version into `unknown-knowledge/kit.manifest.yaml`. That
+stamp is a **birth certificate, not a dependency pin**: it records the schema
+revision, extractor-kind set and fixture vintage the seed was born with. It
+never implies an update channel — upgrading an existing seed is deferred by
+design.
+
+## Versioning
+
+Semver, with kit-specific semantics (D-021): **MAJOR** is a store
+schema-version bump or a breaking change to the engine CLI contract (commands,
+flags, exit codes, output consumed by wrappers); **MINOR** is new extractor
+kinds, new engine surfaces, or a new fixture vintage; **PATCH** is fixes and
+documentation. Changes are tracked in [CHANGELOG.md](CHANGELOG.md) (Keep a
+Changelog form).
+
+## Reading further
+
+- [CONTEXT.md](CONTEXT.md) — the domain glossary. Start here.
+- [decisions/](decisions/) — the kit records its own decisions, in the same
+  format it asks you to use. It eats its own cooking.
+- [docs/publishing.md](docs/publishing.md) — release and supply-chain process
+  (npm provenance, 2FA).
+
+## License and contributing
+
+Licensed under [Apache-2.0](LICENSE) (D-020); redistribution carries the
+[NOTICE](NOTICE) file. Contributions are welcome — especially new extractor
+kinds, and field reports of anchors the extractors could not read. See
+[CONTRIBUTING.md](CONTRIBUTING.md) for the gate (parser + fixture + demo run,
+D-005) and PR expectations.

package/cli/commands/init-copy.js

@@ -0,0 +1,90 @@
+/**
+ * init-copy (KK-17) — thin, flags-only CLI over the payload copy engine
+ * (cli/lib/copy-payload.js). This is the deterministic Phase-1 copy step of
+ * PRD §6 minus the prompts: KK-19's `npx unknown-knowledge init` wraps it
+ * with the interactive UX (root-name prompt, platform multi-select, stack
+ * auto-detection) and the git check-ignore sweep.
+ *
+ * Exit codes (engine contract, payload/engine/lib/exit-codes.js):
+ *   0 — seeded clean. Wrapper collisions that skip-and-report (§6) are
+ *       reported results, not failures — the seed happened.
+ *   2 — refusal (existing/partial seed, dotted root), usage error (incl.
+ *       unknown platform/stack — checked BEFORE seeding), or any engine
+ *       failure. A seed that did not happen is never a silent pass.
+ *   (1 is unused here: copying has no findings/quarantine middle ground.)
+ *
+ * Usage: node cli/init-copy.js --target <dir> [--root <name>]
+ *                              [--stacks <s1,s2>] [--platforms <p1,p2>]
+ *                              [--json]
+ */
+import { fileURLToPath } from 'node:url';
+import { resolve } from 'node:path';
+import process from 'node:process';
+import { copyPayload, loadManifest, DEFAULT_ROOT, SeedRefusal } from '../lib/copy-payload.js';
+import { assertKnownPlatforms, generateWrappers } from '../lib/generate-wrappers.js';
+import { EXIT_CODES } from '../../payload/engine/lib/exit-codes.js';
+import { parseArgs as parseFlags, rethrowIfBug, UsageError } from '../../payload/engine/lib/cli.js';
+
+export const USAGE = 'usage: node cli/init-copy.js --target <dir> [--root <name>] [--stacks <s1,s2>] [--platforms <p1,p2>] [--json]';
+// The kit root, two levels up: cli/commands/<this>.js (UCS-950).
+const kitRoot = fileURLToPath(new URL('../..', import.meta.url));
+
+/** `a, b,,c` → ['a','b','c']; absent → []. */
+const splitList = (value) => (value ?? '').split(',').map((s) => s.trim()).filter(Boolean);
+
+function parseArgs(argv) {
+  const { options } = parseFlags(argv, {
+    boolean: ['json'],
+    value: ['target', 'root', 'stacks', 'platforms'],
+  });
+  if (options.target === undefined) throw new UsageError('--target is required');
+  return {
+    target: options.target,
+    root: options.root ?? DEFAULT_ROOT,
+    stacks: splitList(options.stacks),
+    platforms: splitList(options.platforms),
+    json: !!options.json,
+  };
+}
+
+export function main(argv) {
+  const opts = parseArgs(argv); // a UsageError reaches the harness
+  try {
+    // Unknown platform ids refuse BEFORE the seed — a failed multi-select
+    // must not leave a half-initialized target behind.
+    assertKnownPlatforms(loadManifest(kitRoot), opts.platforms);
+    const result = copyPayload({
+      kitRoot, targetDir: opts.target, rootName: opts.root, stacks: opts.stacks,
+    });
+    let wrappers;
+    try {
+      wrappers = generateWrappers({
+        kitRoot, targetDir: opts.target, rootName: opts.root, platforms: opts.platforms,
+      });
+    } catch (error) {
+      // The seed already landed; shared files may carry sentinel appends, so
+      // a silent rollback could destroy user bytes — name the partial state
+      // instead (a retry refuses on the existing root by design, §6).
+      error.message = `${error.message}\n  the store seed was already created at ${result.root} — remove it (and any wrapper sentinel blocks) before retrying; init refuses on an existing root`;
+      throw error;
+    }
+    if (opts.json) {
+      process.stdout.write(`${JSON.stringify({ ok: true, ...result, wrappers }, null, 2)}\n`);
+    } else {
+      process.stdout.write(
+        `seeded ${result.rootName}/ (kit ${result.version}, stacks: ${result.stacks.join(', ') || 'none'}) `
+        + `— ${result.files.length} files at ${result.root}\n`);
+      for (const w of wrappers) {
+        process.stdout.write(w.action === 'skipped'
+          ? `wrapper ${w.platform}: skipped ${w.target} — ${w.reason}\n`
+          : `wrapper ${w.platform}: ${w.action} ${w.target}\n`);
+      }
+    }
+    return EXIT_CODES.CLEAN;
+  } catch (error) {
+    const kind = error instanceof SeedRefusal ? 'refused' : 'error';
+    process.stderr.write(`init-copy: ${kind}: ${error.message}\n`);
+    rethrowIfBug(error); // a bug is not a refusal — the harness prints its stack
+    return EXIT_CODES.FAILURE;
+  }
+}