@docsworth/cli 0.0.0-stage → 0.3.0

package/LICENSE

@@ -0,0 +1,55 @@
+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:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+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
+
+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

package/README.md

@@ -1,3 +1,239 @@
-# Temporary Holding Version
+# Docsworth
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Your runbooks, owned, verified and executable by every agent.**
+
+Docsworth is a git-native knowledge layer for coding agents. Pages are markdown in your
+own repo. Every page has exactly one owning team in CODEOWNERS and a review date. Agents
+reach the pages through an MCP server that cites only pages a team has verified within
+their review window. Everything else comes back as *excluded: past review date, owned by
+platform*, so the gap is visible rather than silently stale.
+
+- **Customer-owned git.** Plain markdown in your GitHub repo; no lock-in, and it reviews
+  like code.
+- **Enforced ownership.** `docsworth lint` fails CI unless each page's CODEOWNERS rule names
+  exactly one team, and that team matches the page.
+- **Citation gate.** Only `canonical` pages inside their SLA are citable. The gate is
+  fixed and not configurable.
+- **PR-only writes.** Agents propose edits and owners verify pages through pull
+  requests. Nothing writes to the default branch.
+- **Polish without drift.** Agents can restructure and reword a page as a `polish`
+  PR. The server refuses one that changes a code block, inline code, a link, a number
+  or a negation word. The check reads pages as CommonMark does, and is fuzzed against
+  CommonMark's reference parser: no miss in 1.5 million mutated pages.
+- **Mirror, don't migrate.** Read-only Confluence and Notion mirror, scored for
+  freshness, ownership and overlap with canonical pages. With `mirror.serve`, agents
+  see it as context they may never cite.
+- **Skills compiler.** Verified runbooks compile into `SKILL.md` files that agents
+  execute.
+- **Agents read free.** No metering on reads.
+
+## 5-minute quickstart
+
+You need Node 22.12+, a GitHub repo for your knowledge, and Claude Code.
+
+Install the CLI from npm. It's `@docsworth/cli`: `agent-kb` and `docsworth` there are
+not ours.
+
+```bash
+npm install --global @docsworth/cli
+```
+
+```bash
+cd your-knowledge-repo
+docsworth init --team platform     # config, CODEOWNERS, root map, a guide
+docsworth lint .                   # 3 pages, 0 errors, 0 warnings
+```
+
+`init` reads your GitHub org from the repo's remote; in a repo without one yet, add
+`--org <your-org>`. Add `--ci` for a workflow that lints and compiles on every PR.
+
+Install the Claude Code plugin from this repo's marketplace:
+
+```bash
+claude plugin marketplace add docsworth/docsworth
+```
+
+```bash
+claude plugin install docsworth@docsworth
+```
+
+The plugin runs the published CLI through `npx`. To run your own install instead (Docsworth
+pro needs it), set `DOCSWORTH_BIN` in Claude Code's environment to its absolute path, such
+as `$(npm prefix -g)/bin/docsworth`.
+
+Start Claude Code in the knowledge repo, or set `DOCSWORTH_KNOWLEDGE_DIR` to its path, then ask
+*"How do I add a page to our knowledge base?"*. The answer cites
+`guide-writing-pages`.
+
+The server uses your own GitHub identity (`GITHUB_TOKEN`, `GH_TOKEN` or `gh auth
+token`), so your repo and team permissions decide what you see.
+
+## Adopting existing docs
+
+Docs you already have, a Docusaurus site's say, become pages without moving a URL. With
+them under `knowledge/` (or `knowledge_root` in `.knowledge/config.yaml` set to where they
+are), after `init`:
+
+```bash
+docsworth adopt --team docs        # the frontmatter each page lacks, as drafts
+docsworth lint .
+```
+
+`adopt` gives each page the fields it lacks, and keeps everything it has:
+
+- a page's `id` is its own, else its file name, a Docusaurus number prefix removed, so the
+  site's URLs stay where they are;
+- its owner comes from CODEOWNERS, else `--team`;
+- a route link like `/guides/setup` becomes a relative link to the file,
+  `../guides/setup.md`;
+- keys a site generator keeps, such as `sidebar_position`, go in `frontmatter.extra_fields`;
+- images a site serves from its `static/` directory (`/img/x.png`) get a hint naming the
+  `static_dirs` line to add, after which lint reads them there.
+
+A page or link it can't settle stays as it is, listed, and lint fails it until it's fixed
+by hand: a category index like `guides/index.md`, two pages with one file name, a link to
+nothing. `--dry-run` reports and writes nothing.
+
+Adopted pages are drafts, so agents cite none of them yet. Once a team has read its pages:
+
+```bash
+docsworth verify knowledge/guides  # canonical, verified today
+```
+
+Both commands only change files. Commit them and open a pull request, which CODEOWNERS
+sends to the owning team.
+
+If the site stays up, set `site_url` (`https://docs.example.com/docs/`) in the config.
+Then a link to a page someone can't see reads `[restricted page]` by its full URL on the
+site, as it already does by its route. A link without an extension that names nothing
+reads `[restricted page]` too: a route can't be told from a hidden page's.
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `docsworth init [dir]` | Scaffold config, CODEOWNERS, `knowledge/index.md`, a glossary and a writing guide. Never overwrites. |
+| `docsworth lint [dir]` | Frontmatter, CODEOWNERS ownership, links and duplicate ids. Exit 1 on errors; overdue pages only warn. |
+| `docsworth adopt [dir] [--team t]` | Existing pages get the frontmatter they lack, as drafts, and route links become `.md` links; lists what it can't settle. Working tree only; `--dry-run`. |
+| `docsworth verify <paths…>` | The draft or canonical pages under the paths become canonical, verified today. Working tree only; `--dry-run`. |
+| `docsworth stale [dir]` | Pages past their review SLA or without a team owner. |
+| `docsworth coverage [dir] [--html f]` | Percentage team-owned and percentage verified within SLA, by team; optional static dashboard. |
+| `docsworth digest [dir] [--send]` | Weekly per-team digest: due, overdue, most read by agents. Prints unless `--send`. |
+| `docsworth mcp [dir]` | The MCP server (stdio): `search`, `read`, `list`, `stale`, `propose_edit`, `verify`, `draft_page`. Without `dir`, it serves `DOCSWORTH_KNOWLEDGE_DIR`, else the current directory. |
+| `docsworth serve [dir]` | The web app at `127.0.0.1:4747` (overview, search, pages, teams, a link graph, capture), and the same server over HTTP for it and the browser extension, behind a token kept in your state directory (`--print-token`, `--rotate-token`, `--allow-extension <id>`). |
+| `docsworth compile [dir] [--check]` | Canonical runbooks → `skills/<id>/SKILL.md`; `--check` exits 1 on drift. |
+| `docsworth mirror [dir]` | Read-only Confluence and Notion mirror into `.knowledge/mirror`, scored. |
+| `docsworth promote <mirror-id> --owner-team t` | Draft PR copying a mirrored page into `knowledge/`. |
+| `docsworth audit [dir] [--bench d]` | Audit report: coverage, stale and overlapping pages, DIY accuracy score. |
+| `docsworth bench run [dir]` | Citation benchmark: Claude on the raw wiki vs. the ungated layer vs. the gated layer. |
+
+`--as-of YYYY-MM-DD` evaluates SLAs on a fixed date, for reproducible reports.
+
+## How it works
+
+```
+knowledge/*.md ──lint (CI)──▶ CODEOWNERS: one team per page
+      │
+      ├─▶ docsworth mcp ──▶ ACL filter (your GitHub teams) ──▶ citation gate ──▶ agent
+      │                                         propose_edit / verify ──▶ PR only
+      ├─▶ docsworth compile ──▶ skills/<id>/SKILL.md
+Confluence / Notion ──docsworth mirror──▶ .knowledge/mirror (scored, never citable) ──promote──▶ PR
+```
+
+- [docs/format-spec.md](docs/format-spec.md): the format contract.
+- [docs/security-model.md](docs/security-model.md): ACLs, writes and prompt injection.
+  Note that `acl` narrows what agents are served; it isn't confidentiality inside one
+  repo.
+- [docs/enterprise/](docs/enterprise/README.md): for a security review. The two modes, what is
+  inherited from GitHub, a responsibility matrix, a data-flow diagram and a pre-filled
+  questionnaire. Vulnerabilities: [SECURITY.md](SECURITY.md).
+- [docs/rollout.md](docs/rollout.md): org-wide rollout with managed settings.
+
+## Try it on the example
+
+```bash
+npm install
+```
+
+```bash
+npm run docsworth -- --as-of 2026-11-02 lint examples/acme
+```
+
+```bash
+npm run docsworth -- --as-of 2026-11-02 coverage examples/acme --html coverage.html
+```
+
+```bash
+npm run mirror-fixture -w @docsworth-pro/pro -- examples/acme
+```
+
+```bash
+npm run docsworth -- --as-of 2026-11-02 audit examples/acme --out audit
+```
+
+## Browser extension
+
+A side panel for Chrome (and other Chromium browsers) over `docsworth serve`. From the panel
+you can search and read pages, or suggest an addition to one.
+
+**Saving what you read.**
+- **From the menu:** on any page, right-click and choose **Save page to Docsworth**, or
+  select some text and choose **Save selection to Docsworth**.
+- **From the panel:** **Save this page** and **Save the selection** read the tab you opened
+  the panel from with the toolbar button.
+- **In Gmail:** a **Save to Docsworth** button beside a thread's subject.
+
+The page's main content or the selection arrives as markdown, with its headings, links,
+code blocks and tables, and without what the page hides or its navigation. The panel first
+shows the pages that may already cover it, each with **Add the capture here**, then a draft
+page filled from it, with its source. Nothing is written until you open the PR. The
+extension isn't in the Chrome Web Store yet: build it and load it unpacked.
+
+```bash
+npm run build -w @docsworth/extension
+```
+
+1. In Chrome, open `chrome://extensions`, turn on **Developer mode**, choose **Load
+   unpacked** and pick `packages/extension/dist`. Note the extension's id.
+2. Start the server so it answers the extension:
+
+   ```bash
+   docsworth serve --allow-extension <the extension's id>
+   ```
+
+3. Open the extension's options (its toolbar icon, then **Options**). Paste the link `serve`
+   printed, then choose **Connect**. Chrome forgets the token when it quits; paste it again
+   then (`docsworth serve --print-token` shows it).
+
+What it can reach and keep, and why the token is safe from pages:
+[docs/security-model.md](docs/security-model.md#the-browser-extension).
+
+**Gmail checklist.** Gmail's markup isn't a contract. The tests run against Gmail-shaped
+fixtures, so check these by hand, signed in, after loading a new build:
+
+- [ ] An open thread shows **Save to Docsworth** beside its subject. The inbox list shows
+  none.
+- [ ] Clicking it opens the side panel with "From Gmail", related pages, and a draft whose
+  title is the subject and whose body is the expanded messages, each with its sender's name
+  and no addresses.
+- [ ] Moving to another thread moves the button with it. Clicking it while a draft is open
+  shows "Another capture is waiting" rather than replacing the draft.
+- [ ] A thread with collapsed messages captures only the expanded ones: expand what you
+  want in the draft first.
+
+## Development
+
+The one verify target is `npm test`: a typecheck and the vitest suite, including an MCP
+end-to-end test and the ACL matrix. It also builds, packs and installs the real tarball.
+See [AGENTS.md](AGENTS.md), and [docs/releasing.md](docs/releasing.md) for releases.
+
+## Status
+
+v0.3. What's in it, and what hasn't been verified against the real thing yet, is in
+[the release notes](docs/release-notes/v0.3.0.md).
+
+## License
+
+Apache-2.0. Docsworth pro (`@docsworth-pro/pro`: the mirror connectors, digest, reports,
+the SIEM audit sink and the benchmark) is a separate package under its own, proprietary
+licence.

package/dist/cli.d.ts

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+declare const program: Command;
+/** "Now" for every SLA computation; --as-of pins it for reproducible reports. */
+export declare function now(): Date;
+/**
+ * The change happened but its outcome isn't in a required log: say so, and exit 3 (done,
+ * audit degraded) so automation can tell it from success (0) and failure (2).
+ */
+export declare const EXIT_AUDIT_DEGRADED = 3;
+export { program };