brain-wiki 0.1.0.dev0__tar.gz

brain_wiki-0.1.0.dev0/.claude-plugin/marketplace.json

@@ -0,0 +1,16 @@
+{
+  "name": "brain-wiki",
+  "owner": {
+    "name": "brain-wiki contributors"
+  },
+  "description": "brain-wiki: a local-first Markdown second brain shared by your AI agents.",
+  "version": "0.1.0.dev0",
+  "plugins": [
+    {
+      "name": "brain-wiki",
+      "source": "./",
+      "description": "A local-first second brain for AI agents, kept as plain Markdown that you own.",
+      "category": "productivity"
+    }
+  ]
+}

brain_wiki-0.1.0.dev0/.claude-plugin/plugin.json

@@ -0,0 +1,19 @@
+{
+  "name": "brain-wiki",
+  "displayName": "brain-wiki",
+  "version": "0.1.0.dev0",
+  "description": "A local-first second brain for AI agents, kept as plain Markdown that you own.",
+  "author": {
+    "name": "brain-wiki contributors"
+  },
+  "repository": "https://github.com/brain-wiki/brain-wiki",
+  "license": "Apache-2.0",
+  "keywords": [
+    "memory",
+    "agents",
+    "mcp",
+    "markdown",
+    "obsidian",
+    "knowledge-base"
+  ]
+}

brain_wiki-0.1.0.dev0/.gitignore

@@ -0,0 +1,24 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+build/
+dist/
+
+# Tooling caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+
+# Editors and OS
+.idea/
+.vscode/
+.DS_Store
+
+# Local only: drafts, test caches, and the lockfile (dependencies resolve from pyproject.toml)
+.scratch/
+.hypothesis/
+uv.lock

brain_wiki-0.1.0.dev0/.mcp.json

@@ -0,0 +1,16 @@
+{
+  "mcpServers": {
+    "brain-wiki": {
+      "type": "stdio",
+      "command": "uvx",
+      "args": [
+        "--from",
+        "brain-wiki==0.1.0.dev0",
+        "brain",
+        "mcp",
+        "--host",
+        "auto"
+      ]
+    }
+  }
+}

brain_wiki-0.1.0.dev0/.pre-commit-hooks.yaml

@@ -0,0 +1,7 @@
+- id: brain-lint
+  name: brain-wiki lint
+  description: Check staged brain files against the brain-wiki format.
+  entry: brain lint --staged
+  language: python
+  pass_filenames: false
+  files: '(\.md|brain\.toml)$'

brain_wiki-0.1.0.dev0/CHANGELOG.md

@@ -0,0 +1,54 @@
+# Changelog
+
+## 0.1.0.dev0 (2026-10-14)
+
+First release.
+
+- **Brain format**: plain Markdown notes with frontmatter, claims with
+  provenance, and typed relations (`part_of`, `depends_on`,
+  `conflicts_with`, `supersedes`, `related_to`, and their inverses);
+  topics as folders, nested to any depth; immutable inbox episodes;
+  `rules.md`; a managed `AGENTS.md` block.
+- **Index and retrieval**: SQLite FTS5 index outside the brain, freshness
+  checks, guard co-retrieval (superseding and conflicting notes come with
+  every hit), search filters, facets, and intents, orientation, and
+  Obsidian-style browsing (`brain topics`, `notes`, `links`, `backlinks`,
+  `tags`, and more).
+- **Write path**: one episode writer with server-set provenance, secret
+  redaction, size caps, and dedupe; episodes dropped in by hand count as
+  untrusted; checked direct edits (`brain check`, `brain restore`, a
+  per-topic `agent_edits` policy), which agents may make by default; rules
+  that need the user's words and confirmation; `brain mv`.
+- **Runs**: every curated change is locked, gated by lint, recorded with
+  pre-images, committed to git when the brain is a repository, and
+  undoable.
+- **Consolidation**: packets with short handles, a per-op validator, a
+  deterministic writer that never deletes text, and review proposals. Your
+  agent consolidates in its session over MCP; `brain consolidate --prepare`
+  and `--apply` drive it by hand.
+- **Lint and reports**: the BW rule catalog with strict and migrate
+  profiles, cached whole-brain lint, safe fixes as one run, staged-file
+  lint and a pre-commit hook, and browsable reports.
+- **Agents**: a stdio MCP server with thirteen tools and three prompts;
+  `brain connect` for Claude Code, Codex, Antigravity, OpenClaw, and
+  Cursor, with instructions placed where each host reads them; session readers and
+  harvest for Claude Code, Codex, and Antigravity, with headless presets
+  for large backfills; origin lookup; a plugin bundle with three skills;
+  `brain setup` and `brain doctor`.
+- **Import**: overlay adoption of Obsidian vaults in phases, copying into
+  a brain, documents and agent memory files as episodes.
+- **Visualizer**: `brain viz`, a local read-only 3D map of groups,
+  topics, folders, and notes with typed relations and issue highlighting,
+  and HTML, JSON, and GraphML export.
+- **Bench**: offline retrieval, lint, and performance suites, and
+  model-backed consolidation scenarios through headless presets.
+
+Known limitations:
+
+- No privacy levels inside a brain: every agent that may use a brain
+  reads all of it. Keep separate lives in separate brains
+  ([proposal](https://github.com/brain-wiki/brain-wiki/blob/main/docs/proposals/privacy.md)).
+- Maintenance runs when you ask your agent; there is no scheduler
+  ([proposal](https://github.com/brain-wiki/brain-wiki/blob/main/docs/proposals/scheduled-maintenance.md)).
+- Chat apps that need a remote MCP server (ChatGPT, claude.ai, the Gemini
+  app) are not supported ([proposal](https://github.com/brain-wiki/brain-wiki/blob/main/docs/proposals/remote-mcp.md)).

brain_wiki-0.1.0.dev0/CONTRIBUTING.md

@@ -0,0 +1,111 @@
+# Contributing to brain-wiki
+
+## Setup
+
+```sh
+uv sync                      # creates .venv with dev dependencies
+uv run brain --help
+```
+
+## Checks
+
+```sh
+uv run scripts/check.py      # everything CI runs: lint, format, tests, plugin sync, docs brain, visualizer bundle, package contents
+uv run pytest -q             # tests only
+uv run ruff format src tests scripts && uv run ruff check src tests scripts   # format, then lint
+```
+
+After editing `docs/`, regenerate the docs brain (`docs-brain/`, the docs as a
+brain) with `uv run scripts/build_docs_brain.py`; CI fails when it is stale.
+After changing the version or anything under `src/brainwiki/assets/`, run
+`uv run scripts/sync_versions.py`.
+
+### The visualizer front end
+
+`brain viz` serves a prebuilt bundle from `src/brainwiki/viz/app/`, so users
+never need Node. Its source is the
+[brain-wiki-viz](https://github.com/brain-wiki/brain-wiki-viz) repository.
+Clone it next to this one, then:
+
+```sh
+cd ../brain-wiki-viz
+npm ci                       # Node 20.19+, or 22.12+ on Node 22
+npm run check                # type check, unit tests, lockfile check
+git commit …                 # commit the source first: the build records its commit
+npm run build                # writes ../brain-wiki/src/brainwiki/viz/app/
+```
+
+Commit the rebuilt bundle here. `scripts/check.py` checks that the bundle is
+complete and was built from a clean brain-wiki-viz commit
+(`BUILD_INFO.json`); `scripts/check_viz.py --source ../brain-wiki-viz`
+also rebuilds that checkout and fails if the result differs. For live reload,
+run `brain viz --no-open --port 8765` here and `npm run dev` there, then open
+the dev server with the token from `brain viz` (`?t=…`).
+
+## Releasing
+
+CI (`.github/workflows/ci.yml`) runs `scripts/check.py` on Linux and macOS
+with Python 3.11 and 3.13, runs brain-wiki-viz's checks at the bundle's
+commit, and checks that the bundle rebuilds from it. A version tag runs
+`.github/workflows/release.yml`: it checks the tag against the version and
+the changelog, runs the checks, builds, publishes to PyPI with trusted
+publishing, publishes `server.json` to the MCP Registry (final versions
+only), and creates the GitHub release from the changelog entry.
+
+1. Set `version` in `pyproject.toml` to `X.Y.Z`, or a development release
+   such as `X.Y.Z.devN`, and date its changelog entry: `## X.Y.Z (YYYY-MM-DD)`.
+   A development release goes to PyPI like any other, and pip and uv install
+   it while no final release exists; the GitHub release is marked a
+   pre-release, and the MCP Registry, a public catalog, is skipped.
+2. `uv run scripts/sync_versions.py`, then commit.
+3. `git tag vX.Y.Z && git push origin main vX.Y.Z`.
+4. Move `main` to the next development version (`X.Y.(Z+1).dev0` after
+   `X.Y.Z`, `X.Y.Z.dev(N+1)` after `X.Y.Z.devN`) with a new `(unreleased)`
+   entry, run `sync_versions.py`, commit, and push. The plugin files keep
+   pointing at the newest dated release, because marketplaces install the
+   plugin from `main`.
+
+One-time setup: a trusted publisher on PyPI for this repository, workflow
+`release.yml`, environment `pypi` (and that environment in the GitHub
+repository settings); private vulnerability reporting turned on (see
+`SECURITY.md`).
+
+## Where things are
+
+| Path | What |
+|---|---|
+| `docs/design/` | The design of what is implemented. Read the relevant document before changing behavior, and update it in the same change. |
+| `docs/proposals/` | Designs not yet built, and the backlog. Building one moves its content into `docs/design/`. |
+| `src/brainwiki/` | The package (layout in `docs/design/13-engineering.md` §2) |
+| `src/brainwiki/assets/` | Prompts the engine uses; the skills' copies are generated from them |
+| `plugin.json`, `mcp.json`, `.mcp.json`, `mcp_config.json`, `rules/`, `skills/`, `.claude-plugin/`, `server.json` | The plugin, served from the repository root. These names, and `hooks/` and `hooks.json`, are reserved by hosts; the bundle ships no hooks. |
+| `src/brainwiki/viz/app/` | The visualizer's built bundle (source: brain-wiki-viz); do not edit by hand |
+| `scripts/sync_versions.py` | Writes the version into every manifest and regenerates skill references (`--check` in CI) |
+| `tests/fixtures/` | Synthetic fixtures only |
+
+## Rules
+
+- **No real personal data anywhere**: examples and fixtures use the
+  fictional notes app "Lumen" and generic paths.
+- **Test fixtures never contain credentials**, even fake ones in their real
+  shape; build such strings at runtime in the test.
+- **Minimal visibility.** Modules inside a package are private
+  (`_name.py`); a package's API is what its `__init__.py` re-exports, and
+  code outside the package imports only that (tests may reach private
+  modules). Inside a module, a name is public only when another module, a
+  test, or a script uses it. `scripts/check_visibility.py` (part of
+  `scripts/check.py`) enforces both; `docs/design/13-engineering.md` §2 has
+  the details.
+- **Writers never reflow text.** Anything that edits a note changes only the
+  lines it must; add a test that untouched lines survive byte for byte.
+- **Every curated change goes through `runs.Run`** so it is recorded,
+  locked, gated by lint, and undoable.
+- **The CLI starts fast**: subcommand modules are imported lazily, and only
+  `brain mcp` imports the MCP SDK (`docs/design/07-interfaces.md` §2.4).
+- One version number, in `pyproject.toml`; run `scripts/sync_versions.py`
+  after changing it or any file under `src/brainwiki/assets/`.
+
+## Commits and pull requests
+
+Conventional Commits (`feat(lint): …`, `fix(index): …`). The message says
+why the change exists, not what the diff shows.

brain_wiki-0.1.0.dev0/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.