lodestar-brain 0.1.0__tar.gz

lodestar_brain-0.1.0/.gitattributes

@@ -0,0 +1,6 @@
+# Normalize line endings: store text as LF in the repo, check out native.
+* text=auto eol=lf
+
+# Binary / generated artifacts — never normalize
+*.whl binary
+*.tar.gz binary

lodestar_brain-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: python -m pip install -e ".[dev]"
+      - name: Tests
+        run: python -m pytest -q
+      - name: Demo produces a non-empty agenda (network-free)
+        run: |
+          out="$(lodestar demo)"
+          echo "$out" | head -20
+          echo "$out" | grep -q "^# Agenda" || { echo "demo produced no agenda"; exit 1; }
+          echo "$out" | grep -q "Bridge" || { echo "bridge goal missing"; exit 1; }
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build wheel + sdist
+        run: |
+          python -m pip install build
+          python -m build
+      - name: Verify the sample vault is bundled in the wheel
+        run: python -c "import zipfile,glob; w=glob.glob('dist/*.whl')[0]; names=zipfile.ZipFile(w).namelist(); assert any(n.endswith('.md') and 'sample/notes' in n for n in names), 'sample not bundled'; print('sample bundled OK')"
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*

lodestar_brain-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+env/
+
+# Tooling
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Lodestar runtime output (default state dir)
+.lodestar/
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store
+Thumbs.db

lodestar_brain-0.1.0/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes to lodestar-brain are documented here.
+The format follows [Keep a Changelog](https://keepachangelog.com/); this project
+uses [Semantic Versioning](https://semver.org/).
+
+## [0.1.0] — 2026-06-24
+
+First public release: the self-thinking core (L4 → L6 → L8) over any folder of
+Markdown notes.
+
+### Added
+- **Config** (`lodestar.yaml`): corpus/state dirs, retrieval backend, flat
+  `priority_topics`, `data_domains` / `machinery_domains` (default empty).
+- **Corpus** reader: tolerant Markdown + YAML-frontmatter parsing, one wikilink
+  parser, one resolver (title → filename → alias → path). BOM-safe.
+- **Retrieval**: a `Retriever` protocol (bring-your-own) + a zero-dependency
+  pure-Python `BM25Retriever` default. `lodestar search`.
+- **L4 graph**: PageRank + degree hubs, label-propagation communities, broker
+  scoring, structural-hole bridge gaps, orphan/dead-link detection. Strips code
+  regions before edge-building. `lodestar graph`.
+- **L6 insights**: graph-derived synthesis candidates (headline); aging-authority
+  and stalled-inquiry (opt-in, from `updated:` / `status:`). `lodestar insights`.
+- **L8 roadmap**: a self-directed, ranked agenda (sparse-domain, bridge,
+  near-orphan, alignment goals), value × gap × weight scoring, optional
+  `priority_topics` alignment, per-goal suggested-step checklists. Writes a
+  unified `AGENDA.md`. `lodestar roadmap`.
+- **`lodestar run`** (whole chain) and **`lodestar demo`** (bundled sample vault,
+  zero setup).
+
+### Notes
+- Retrieval and execution are **bring-your-own**: the deliverable is the agenda;
+  a human or your own agent acts on it. There is no executor, approval gate, or
+  campaign state machine.
+- Deferred to a later release: a typed-relationship layer (contradiction /
+  supersession insights), semantic/reranker retrieval adapters, and an
+  outcome-calibrated self-tuning rung (needs sustained usage data).

lodestar_brain-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to lodestar-brain
+
+Thanks for your interest! lodestar-brain is small, pure-Python, and dependency-light
+on purpose — contributions that keep it that way are the easiest to merge.
+
+## Development setup
+
+```bash
+git clone https://github.com/Trashpanda62/lodestar-brain
+cd lodestar-brain
+python -m pip install -e ".[dev]"
+python -m pytest        # all tests should pass
+lodestar demo           # the bundled sample agenda
+```
+
+## Principles
+
+- **Pure-Python, deterministic, offline.** The core (graph/insight/roadmap +
+  BM25) takes no runtime dependency beyond PyYAML and never touches the network.
+  New backends (embeddings, rerankers, vector DBs) belong behind the `Retriever`
+  protocol as optional extras, never in the core path.
+- **The brain proposes; it never executes.** lodestar emits an agenda + reports.
+  It must never edit the user's notes, run tasks, spend money, or delete things.
+- **Config-driven, not hard-coded.** No vault-specific domain names or paths in
+  the engines — read them from `LodestarConfig`.
+- **Reports go to the state dir, never into the user's note corpus.**
+
+## Tests
+
+Every behavior change needs a test. The `lodestar demo` over the bundled sample
+vault is the integration contract — it must keep producing a non-empty, diverse
+agenda (the CI asserts this).
+
+## Pull requests
+
+Keep PRs focused. Run `pytest` and `lodestar demo` before opening. New CLI
+commands or config keys should update the README and `CHANGELOG.md`.
+
+By contributing you agree your contributions are licensed under Apache-2.0.

lodestar_brain-0.1.0/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.

lodestar_brain-0.1.0/NOTICE

@@ -0,0 +1,14 @@
+lodestar-brain
+Copyright 2026 The lodestar-brain authors.
+
+This product includes software developed by the lodestar-brain authors.
+
+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 in the accompanying LICENSE file or at:
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Lodestar-brain is the standalone, generalized extraction of the "Lodestar"
+self-directing knowledge-graph engine. It carries no third-party vendored code;
+its only runtime dependency is PyYAML (also Apache-2.0 licensed).

lodestar_brain-0.1.0/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: lodestar-brain
+Version: 0.1.0
+Summary: A self-directing second brain for your markdown notes: builds a knowledge graph and hands you a ranked agenda of what to grow, bridge, and fix next.
+Project-URL: Homepage, https://github.com/Trashpanda62/lodestar-brain
+Project-URL: Repository, https://github.com/Trashpanda62/lodestar-brain
+Project-URL: Issues, https://github.com/Trashpanda62/lodestar-brain/issues
+Author: Trashpanda62
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: knowledge-graph,markdown,note-taking,obsidian,pkm,second-brain,zettelkasten
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.9
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# lodestar-brain
+
+**A self-directing second brain for your markdown notes.**
+
+Point it at any folder of Markdown (an Obsidian vault, a Zettelkasten, a docs
+tree) and lodestar-brain builds a knowledge graph and hands you a **ranked
+agenda of what to grow, bridge, and fix next** — the sparse-but-important
+topics, the structural holes between clusters, the near-orphan notes. You (or
+your own LLM) act on the agenda; lodestar tells you *where to point your
+attention*.
+
+> Status: **v0.1.** The self-thinking core — graph (L4), insights (L6), and the
+> self-directing roadmap (L8) — is complete and runs over any folder of Markdown.
+
+```bash
+pip install git+https://github.com/Trashpanda62/lodestar-brain
+lodestar demo            # see it work on a bundled sample vault — zero setup
+```
+
+*(Not on PyPI yet — install from source as above. A PyPI release is planned.)*
+
+## What it is (and isn't)
+
+- **It is** a *self-directing* brain: it derives its own knowledge agenda from the
+  shape of your notes (graph centrality, cross-domain gaps, orphans) plus
+  optional priority topics you declare.
+- **It is not** an autonomous executor. lodestar **proposes** an agenda; it never
+  edits your notes, runs tasks, or "maintains your vault" on its own. Execution
+  is bring-your-own — a human, or an agent you wire up.
+- **Retrieval is bring-your-own too:** a pure-Python BM25 backend ships by
+  default (zero extra dependencies). Plug in your own (embeddings, a reranker, a
+  vector DB) by implementing the small `Retriever` protocol.
+
+## The ladder
+
+lodestar-brain ships the **self-thinking** layers of a knowledge graph:
+
+| Rung | Does | Command |
+|------|------|---------|
+| L4 — relate | builds the link graph: hubs, clusters, orphans, cross-domain bridge gaps | `lodestar graph` |
+| L6 — notice | surfaces emergent observations (synthesis candidates, aging hubs, stalled questions) | `lodestar insights` |
+| L8 — direct | derives + ranks its own agenda of what to grow/connect/fix next | `lodestar roadmap` |
+
+*(The retrieval substrate L1–L3 is bring-your-own — a zero-dependency BM25 ships
+as the default. The outcome-calibrated self-tuning rung L9 is deferred to a later
+release: it needs weeks of real usage data before it does anything.)*
+
+## Install
+
+```bash
+pip install git+https://github.com/Trashpanda62/lodestar-brain
+```
+
+Pure-Python; the only runtime dependency is PyYAML. (PyPI release planned.)
+
+## Quickstart
+
+**See it work first — zero config:**
+
+```bash
+lodestar demo            # runs the whole chain over a bundled sample vault
+```
+
+**Then point it at your own notes:**
+
+```bash
+# 1. create a config
+cp lodestar.example.yaml lodestar.yaml
+
+# 2. edit lodestar.yaml so corpus_dir points at your notes folder
+#    corpus_dir: /path/to/your/vault
+
+# 3. run the whole chain → AGENDA.md in ./.lodestar/
+lodestar run
+```
+
+```yaml
+# lodestar.yaml — minimal
+corpus_dir: /path/to/your/notes
+priority_topics:                 # optional — omit for pure curiosity mode
+  - name: "My current focus"
+    domains: [project-x]         # a folder name in your vault
+```
+
+## Commands
+
+| Command | What it does |
+|---------|--------------|
+| `lodestar demo` | run the whole chain over a bundled sample vault (zero setup) |
+| `lodestar info` | summarize what lodestar sees in your corpus |
+| `lodestar graph` | compute the knowledge graph → `brain-map.md` |
+| `lodestar insights` | surface emergent observations → `insights.md` |
+| `lodestar roadmap` | derive the ranked agenda → `AGENDA.md` |
+| `lodestar run` | all of the above in one pass |
+| `lodestar search <q>` | BM25 search over the corpus |
+
+Outputs go to your `state_dir` (default `./.lodestar`) — never into your notes.
+The headline deliverable is **`AGENDA.md`**: a ranked, actionable list of what to
+grow, connect, and fix next, with a by-hand checklist per item. You (or your own
+agent) act on it — lodestar proposes, it never edits your notes.
+
+## Configuration
+
+See [`lodestar.example.yaml`](lodestar.example.yaml) for the full annotated
+config. Notes need **no special frontmatter** — titles fall back to filenames,
+domains to the top folder. If you do use YAML frontmatter (`title`, `domain`,
+`aliases`), lodestar reads it.
+
+## License
+
+[Apache-2.0](LICENSE). See [NOTICE](NOTICE).

lodestar_brain-0.1.0/README.md

@@ -0,0 +1,111 @@
+# lodestar-brain
+
+**A self-directing second brain for your markdown notes.**
+
+Point it at any folder of Markdown (an Obsidian vault, a Zettelkasten, a docs
+tree) and lodestar-brain builds a knowledge graph and hands you a **ranked
+agenda of what to grow, bridge, and fix next** — the sparse-but-important
+topics, the structural holes between clusters, the near-orphan notes. You (or
+your own LLM) act on the agenda; lodestar tells you *where to point your
+attention*.
+
+> Status: **v0.1.** The self-thinking core — graph (L4), insights (L6), and the
+> self-directing roadmap (L8) — is complete and runs over any folder of Markdown.
+
+```bash
+pip install git+https://github.com/Trashpanda62/lodestar-brain
+lodestar demo            # see it work on a bundled sample vault — zero setup
+```
+
+*(Not on PyPI yet — install from source as above. A PyPI release is planned.)*
+
+## What it is (and isn't)
+
+- **It is** a *self-directing* brain: it derives its own knowledge agenda from the
+  shape of your notes (graph centrality, cross-domain gaps, orphans) plus
+  optional priority topics you declare.
+- **It is not** an autonomous executor. lodestar **proposes** an agenda; it never
+  edits your notes, runs tasks, or "maintains your vault" on its own. Execution
+  is bring-your-own — a human, or an agent you wire up.
+- **Retrieval is bring-your-own too:** a pure-Python BM25 backend ships by
+  default (zero extra dependencies). Plug in your own (embeddings, a reranker, a
+  vector DB) by implementing the small `Retriever` protocol.
+
+## The ladder
+
+lodestar-brain ships the **self-thinking** layers of a knowledge graph:
+
+| Rung | Does | Command |
+|------|------|---------|
+| L4 — relate | builds the link graph: hubs, clusters, orphans, cross-domain bridge gaps | `lodestar graph` |
+| L6 — notice | surfaces emergent observations (synthesis candidates, aging hubs, stalled questions) | `lodestar insights` |
+| L8 — direct | derives + ranks its own agenda of what to grow/connect/fix next | `lodestar roadmap` |
+
+*(The retrieval substrate L1–L3 is bring-your-own — a zero-dependency BM25 ships
+as the default. The outcome-calibrated self-tuning rung L9 is deferred to a later
+release: it needs weeks of real usage data before it does anything.)*
+
+## Install
+
+```bash
+pip install git+https://github.com/Trashpanda62/lodestar-brain
+```
+
+Pure-Python; the only runtime dependency is PyYAML. (PyPI release planned.)
+
+## Quickstart
+
+**See it work first — zero config:**
+
+```bash
+lodestar demo            # runs the whole chain over a bundled sample vault
+```
+
+**Then point it at your own notes:**
+
+```bash
+# 1. create a config
+cp lodestar.example.yaml lodestar.yaml
+
+# 2. edit lodestar.yaml so corpus_dir points at your notes folder
+#    corpus_dir: /path/to/your/vault
+
+# 3. run the whole chain → AGENDA.md in ./.lodestar/
+lodestar run
+```
+
+```yaml
+# lodestar.yaml — minimal
+corpus_dir: /path/to/your/notes
+priority_topics:                 # optional — omit for pure curiosity mode
+  - name: "My current focus"
+    domains: [project-x]         # a folder name in your vault
+```
+
+## Commands
+
+| Command | What it does |
+|---------|--------------|
+| `lodestar demo` | run the whole chain over a bundled sample vault (zero setup) |
+| `lodestar info` | summarize what lodestar sees in your corpus |
+| `lodestar graph` | compute the knowledge graph → `brain-map.md` |
+| `lodestar insights` | surface emergent observations → `insights.md` |
+| `lodestar roadmap` | derive the ranked agenda → `AGENDA.md` |
+| `lodestar run` | all of the above in one pass |
+| `lodestar search <q>` | BM25 search over the corpus |
+
+Outputs go to your `state_dir` (default `./.lodestar`) — never into your notes.
+The headline deliverable is **`AGENDA.md`**: a ranked, actionable list of what to
+grow, connect, and fix next, with a by-hand checklist per item. You (or your own
+agent) act on it — lodestar proposes, it never edits your notes.
+
+## Configuration
+
+See [`lodestar.example.yaml`](lodestar.example.yaml) for the full annotated
+config. Notes need **no special frontmatter** — titles fall back to filenames,
+domains to the top folder. If you do use YAML frontmatter (`title`, `domain`,
+`aliases`), lodestar reads it.
+
+## License
+
+[Apache-2.0](LICENSE). See [NOTICE](NOTICE).

lodestar_brain-0.1.0/lodestar.example.yaml

@@ -0,0 +1,30 @@
+# lodestar-brain configuration. Copy to `lodestar.yaml` and edit.
+# Relative paths resolve against the directory holding this file.
+
+# REQUIRED: the folder of markdown notes to reason over.
+corpus_dir: ./notes
+
+# Where lodestar writes its output (graph, agenda, reports). Default: ./.lodestar
+state_dir: ./.lodestar
+
+# Retrieval backend (used by `lodestar search`).
+#   bm25 — pure-Python, zero dependencies (the only built-in backend)
+# Bring your own (embeddings, a reranker, a vector DB) by implementing the
+# lodestar_brain.retrieval.Retriever protocol.
+retrieval:
+  backend: bm25
+
+# OPTIONAL: priority topics steer the roadmap toward what you care about.
+# Omit this whole block for pure "curiosity mode" (graph-shape only).
+priority_topics:
+  - name: "Example Project"
+    domains: [project-x]   # corpus folder name(s)
+    weight: 1.0
+
+# Folders that hold DATA, not knowledge to grow (people records, logs, media).
+# Excluded from growth goals. Default: none.
+data_domains: []
+
+# Folders that are tooling / scaffolding / meta. Excluded from goals.
+# Default: none.
+machinery_domains: []