{"_id":"@captain_z/create-beaconfold","name":"@captain_z/create-beaconfold","dist-tags":{"latest":"0.3.0"},"versions":{"0.3.0":{"name":"@captain_z/create-beaconfold","version":"0.3.0","private":false,"description":"Create BeaconFold LLM Wiki instances from extensible templates.","bin":{"create-beaconfold":"cli/bin/create-beaconfold","beaconfold":"cli/bin/beaconfold"},"keywords":["beaconfold","llm-wiki","knowledge-base","scaffolding","create"],"publishConfig":{"access":"public"},"dependencies":{"@clack/prompts":"^0.10.1"},"engines":{"node":">=20"},"license":"MIT","scripts":{"test:cli":"node --test cli/tests/*.test.mjs","test":"npm run test:cli","verify":"npm run test:cli"},"_id":"@captain_z/create-beaconfold@0.3.0","_integrity":"sha512-vmxOcj5dkz0gDrQ2CwdQ5EZ1kNFSzschNMNZw3o7/g4knKtaxM95JPpzf0QvFswJKxQI7oDu0IanlkDiRUwarQ==","_resolved":"/private/var/folders/77/_7bjwyj51f533b4bdgv_tw500000gn/T/0c282e10e6d3a827ee19f258cf4e750f/captain_z-create-beaconfold-0.3.0.tgz","_from":"file:captain_z-create-beaconfold-0.3.0.tgz","_nodeVersion":"24.4.1","_npmVersion":"11.11.0","dist":{"integrity":"sha512-vmxOcj5dkz0gDrQ2CwdQ5EZ1kNFSzschNMNZw3o7/g4knKtaxM95JPpzf0QvFswJKxQI7oDu0IanlkDiRUwarQ==","shasum":"0c1c01a19d4bf140e641f742a1ee2e2efa7ec401","tarball":"https://registry.npmjs.org/@captain_z/create-beaconfold/-/create-beaconfold-0.3.0.tgz","fileCount":221,"unpackedSize":962767,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCID3BdbQ/kCUJVzVRSxL2MZpSWtmJ8D0DqzDX+v+jpmCxAiAg3r/GhENE1dipI0bSHU0ezSxubjMA8JhjRkHOp3bPRw=="}]},"_npmUser":{"name":"captain_z","email":"305168898@qq.com"},"directories":{},"maintainers":[{"name":"captain_z","email":"305168898@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/create-beaconfold_0.3.0_1781436603754_0.4634300419574846"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-14T11:30:03.557Z","0.3.0":"2026-06-14T11:30:03.948Z","modified":"2026-06-14T11:30:04.189Z"},"maintainers":[{"name":"captain_z","email":"305168898@qq.com"}],"description":"Create BeaconFold LLM Wiki instances from extensible templates.","keywords":["beaconfold","llm-wiki","knowledge-base","scaffolding","create"],"license":"MIT","readme":"# BeaconFold\n\nBeaconFold is an npm create-style scaffold for source-backed LLM Wiki instances.\n\nThe repository root is the generator package, not a generated knowledge base. A generated instance owns the Markdown-first knowledge system (`raws`, `wiki`, `graph`, `claims`, `projects`, `outputs`, `system`, `tools`, and optional `interfaces/viewer`).\n\n## Root Layout\n\n```txt\ncli/        create-beaconfold and beaconfold package commands\ntemplates/  extensible instance templates\nviewer/     reusable read-only Astro viewer copied into instances when enabled\n```\n\nPackage-level files such as `package.json`, `README.md`, `LICENSE`, `.gitignore`, and `AGENTS.md` stay at the root. Instance directories must stay under `templates/<name>/files/` or inside generated projects.\n\n## Create An Instance\n\n```bash\nnpm create beaconfold@latest ./Nervia\n```\n\nProviding a target path uses the recommended LLM Wiki defaults and does not open a long questionnaire. Run `npm create beaconfold@latest` without a target for the short wizard, or add `-- --advanced` when you need to choose language, source strictness, privacy boundary, and feature flags.\n\nLocal development entrypoints:\n\n```bash\npnpm install\npnpm test\nnode cli/bin/create-beaconfold ./Nervia\nnode cli/bin/create-beaconfold --advanced\nnode cli/bin/beaconfold sync --target ./Nervia --dry-run\n```\n\nThe default template is `templates/llm-wiki`. It renders instance-owned files from `templates/llm-wiki/render`, copies template-owned skeleton files from `templates/llm-wiki/files`, writes `beaconfold.viewer.json` from `templates/llm-wiki/template.json`, and copies the root `viewer/` source to `interfaces/viewer/` when the viewer feature is enabled.\n\n## Generated Instance Shape\n\nA typical instance created from `llm-wiki` contains:\n\n```txt\nAGENTS.md\nREADME.md\nbeaconfold.instance.json\nbeaconfold.viewer.json\npurpose.md\nindex.md\nlog.md\nraws/\nwiki/\nclaims/\ngraph/\nprojects/\noutputs/\nsystem/\ntools/\ninterfaces/viewer/   optional, when viewer is enabled\n```\n\nThe instance viewer is read-only. Product navigation is driven by the generated `beaconfold.viewer.json` and should surface the knowledge library, source ledger, relation graph, claims, projects, and outputs. Template-maintenance routes such as system docs and tools are not product navigation in instance mode.\n\n## Template Sync\n\nTemplate sync is run from the generator package, not from the repository root as an instance:\n\n```bash\nnode cli/bin/beaconfold sync --target /path/to/Nervia --dry-run\nnode cli/bin/beaconfold sync --target /path/to/Nervia --apply\n```\n\nSync updates template-owned files and skips instance-owned files such as `README.md`, `purpose.md`, `index.md`, `log.md`, `AGENTS.md`, `wiki/home.md`, active ledgers, and viewer config.\n\n## Verification\n\n```bash\npnpm test\nnpm pack --dry-run\n```\n\nFor a generated instance:\n\n```bash\ncd /path/to/Nervia\n./tools/verify-contracts\npnpm --dir interfaces/viewer build\n```\n\nThe viewer remains an adapter. It reads repository files for display and must not crawl sources, ingest knowledge, promote review state, or write instance files.\n","readmeFilename":"README.md","_rev":"1-d8aa2dfdbc677fc145fd3b2117043d72"}