Metadata-Version: 2.1
Name: knowledgeweaver
Version: 0.1.0
Summary: CLI-first cognitive indexing pipeline
Author-email: Janni Osier <janni@watttonn.com>
Maintainer-email: Janni Osier <janni@watttonn.com>
License: 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 2026 KnowledgeWeaver contributors
        
        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.
        
Project-URL: Homepage, https://github.com/WattTonn/KnowledgeWeaver
Project-URL: Repository, https://github.com/WattTonn/KnowledgeWeaver
Project-URL: Issues, https://github.com/WattTonn/KnowledgeWeaver/issues
Project-URL: Changelog, https://github.com/WattTonn/KnowledgeWeaver/blob/main/CHANGELOG.md
Keywords: cli,knowledge-graph,llm,postgres,rag
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyYAML<7.0,>=6.0
Requires-Dist: langchain-core<0.4,>=0.3.69
Requires-Dist: langchain-anthropic<0.4,>=0.3.18
Requires-Dist: langchain-openai<0.4,>=0.3.28
Requires-Dist: openai<2.0,>=1.99
Requires-Dist: pgvector<1.0,>=0.3
Requires-Dist: psycopg[binary]<4.0,>=3.2
Requires-Dist: pydantic<3.0,>=2.11
Provides-Extra: dev
Requires-Dist: build<2.0,>=1.2; extra == "dev"
Requires-Dist: pytest<9.0,>=7.4; extra == "dev"
Requires-Dist: twine<7.0,>=5.1; extra == "dev"

# KnowledgeWeaver

[![CI](https://github.com/WattTonn/KnowledgeWeaver/actions/workflows/ci.yml/badge.svg)](https://github.com/WattTonn/KnowledgeWeaver/actions/workflows/ci.yml)
[![Python](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/)
[![License](https://img.shields.io/badge/license-Apache%202.0-green)](LICENSE)
[![Status](https://img.shields.io/badge/status-alpha-orange)](#)

KnowledgeWeaver was inspired by Andrej Karpathy's [LLM Wiki](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f) note — the idea that LLMs should compile sources into a persistent intermediate layer instead of re-reading raw text on every query. In KnowledgeWeaver, that intermediate layer is made of Cognodes: small, typed units of knowledge that stay readable on disk.

## Why Cognodes

Most RAG systems chunk raw documents at query time. KnowledgeWeaver does the structure work up front: each source becomes a set of typed Cognodes such as `concept`, `fact`, `experience`, `narrative`, `opinion`, and `known_unknown`. Those units can point to each other through typed relations such as `depends_on`, `instantiates`, and `evidences`.

That gives you:

- readable markdown you can grep, diff, and version
- structure-first retrieval over typed fields and relations
- a compiled Postgres index you can delete and rebuild from markdown at any time

See [`cognodes/examples/karpathy-llm-wiki`](cognodes/examples/karpathy-llm-wiki/) for a worked example.

## What You Can Do

- `kw distill`: turn raw text or files into Cognode markdown
- `kw query-cognode`: answer questions from Cognode markdown on disk
- `kw index`: compile Cognodes into Postgres
- `kw query`: query the Postgres compiled index
- `kw eval-distill`: run YAML distillation evals

## Quickstart

### Option A: local CLI loop

Before you start, make sure you have:

- Python `3.10+`
- Docker Desktop or Docker Engine with `docker compose`
- Ollama installed and running at `http://localhost:11434/v1`
- local Ollama models configured for both generation and embeddings

Notes:

- The bundled Postgres setup is started through Docker, so you do not need to install Postgres separately if you use the commands below.
- The default config is written to `~/.knowledgeweaver/kw.yaml` and the generated Docker env file is written to `~/.knowledgeweaver/docker-compose.env`.
- If your Ollama model names differ from the defaults, edit `~/.knowledgeweaver/kw.yaml` after `kw config init` so the `extraction`, `query_*`, and `embedding` model entries match what you have installed locally.
- Run the Docker command from the repo root so `docker-compose.postgres.yml` and `Dockerfile.postgres` are available.

```bash
pip install .
kw config init
# edit ~/.knowledgeweaver/kw.yaml if you need different Ollama model names
kw config validate
# start the bundled pgvector/Postgres instance on port 55432
docker compose --env-file ~/.knowledgeweaver/docker-compose.env -f docker-compose.postgres.yml up -d --build
kw db init
kw distill --text "Revenue dropped by 4% in Q2 due to lower enterprise renewals."
kw query-cognode "What caused the Q2 revenue drop?"
kw index
kw query "What caused the Q2 revenue drop?"
```

The default config assumes:

- Ollama at `http://localhost:11434/v1`
- local Postgres credentials stored in `~/.knowledgeweaver/docker-compose.env`
- config at `~/.knowledgeweaver/kw.yaml`

### Option B: using with agents

Claude Code auto-registers the bundled skills under `skills/cognode-distillation/` and `skills/cognode-query/`.

For Codex or other agents, point them at the skill files directly and keep the Cognode markdown as the canonical artifact. The intended workflow is still:

1. distill raw text into Cognodes
2. save Cognodes as markdown
3. query markdown directly with `kw query-cognode` or compile into Postgres with `kw index`

## Common Commands

Show config resolution:

```bash
kw config path
kw config show
kw config validate
```

Distill:

```bash
kw distill --input ./notes/article.txt
kw distill --text "Revenue dropped by 4% in Q2 due to lower enterprise renewals."
cat article.txt | kw distill --stdin
kw distill --input ./inbox --recursive
```

Query markdown directly:

```bash
kw query-cognode "What caused the Q2 revenue drop?"
```

Compile and query Postgres:

```bash
kw index
kw query "What caused the Q2 revenue drop?"
kw query "What caused the Q2 revenue drop?" --debug
```

Initialize Postgres schema explicitly:

```bash
kw db init
kw db init --profile postgres_local
```

Useful flags:

- `--config`: use a non-default config file
- `--profile`: select a profile from the config
- `--doc-id`, `--title`, `--author`, `--source-uri`, `--created-at`: attach metadata during distillation
- `--top-k`: control retrieval breadth for `query` and `query-cognode`

## Configuration

`kw` looks for config in this order:

1. `--config <path>`
2. `$KW_HOME/kw.yaml` if `KW_HOME` is set, otherwise `~/.knowledgeweaver/kw.yaml`
3. `./kw.yaml`

Inside the config, `kw_home` is the root for generated files:

- `${kw_home}/cognodes`
- `${kw_home}/cognodes/manifests`
- `${kw_home}/logs`
- `${kw_home}/docker-compose.env`

After changing `kw_home`, run `kw config validate` again so `kw` refreshes `docker-compose.env`.

## Docker

This repo includes:

- [`docker-compose.postgres.yml`](docker-compose.postgres.yml)
- [`Dockerfile.postgres`](Dockerfile.postgres)

Start the bundled local Postgres:

```bash
kw config validate
docker compose --env-file ~/.knowledgeweaver/docker-compose.env -f docker-compose.postgres.yml up -d --build
kw db init
```

The bundled setup uses port `55432`.

## Providers

Supported provider styles:

- `ollama`
- `openai-compatible`
- `anthropic`

For each model under `profiles.<name>.models.<key>`, you usually set:

- `provider`
- `model`
- `api_base`
- one auth method: `api_key`, `api_key_env`, `oauth_token`, or `oauth_token_env`
- optional tuning fields such as `timeout_seconds`, `temperature`, `max_tokens`, and `dimensions`

`kw config show` redacts inline secrets and DSN passwords before printing.

## Notes

- Use `kw query-cognode` when you want the markdown-only workflow.
- Use `kw query` when you want structure-first retrieval over the compiled Postgres index.
- Rebuilding Postgres should never require editing Cognodes.
- Changing `kw_home` moves Cognodes, manifests, logs, and Docker helper files together.

## Project Policy

- [Contributing guide](https://github.com/WattTonn/KnowledgeWeaver/blob/main/CONTRIBUTING.md)
- [Code of conduct](https://github.com/WattTonn/KnowledgeWeaver/blob/main/CODE_OF_CONDUCT.md)
- [Security policy](https://github.com/WattTonn/KnowledgeWeaver/blob/main/SECURITY.md)
