Skip to main content

Markdown-first durable memory for AI agents, existing repos, and knowledgebases.

Project description

Owledge

Drop-in durable project memory for existing Markdown repos and Obsidian-style vaults: no migration, no vector DB, no wiki-link rewrite.

Version License: MIT Storage: Markdown Runtime support CI Docs

Owledge gives agents durable local Markdown artifacts: plans, evidence, reviews, handoffs, and decisions that stay readable across sessions, tools, teams, and existing vaults.

Use it when agents are losing project context, plans are stuck in chat, multiple runtimes need a shared handoff surface, or a mature knowledgebase needs traceable decisions without a migration.

Core idea: Markdown is the source of truth; indexes, reports, graphs, benchmarks, and runtime adapters are generated or optional views.

Release proof: local release gates pass with additive writes by default, private runtime capture, metadata-first KB scan, and no required OS-wide setup. CI runs platform-neutral Python gates; broader runtime installs remain local adapter support, not marketplace certification.

Minimal by default: start with principles and skills only. Add project files, runtime adapters, or add-ons only when the current project needs durable local artifacts, runtime capture, proof assets, or release evidence.

Repo Layout

This repository ships product source from templates/agent-memory/. The internal/agent-memory/ directory is the maintainers' dogfood workspace (generated artifacts, not shipped). The tools/ directory holds the Python CLI. See docs/distribution.md for the full Dogfooding vs. Product breakdown.

Table Of Contents

Why It Exists

Owledge is for teams and power users who already work in Markdown, Obsidian, LLM wikis, or agent-driven coding repos and need project context to survive beyond one chat session.

  • Keep context durable instead of rebuilding it from transcript history.
  • Keep MVP plans grounded with evidence, cutlines, reviews, and handoffs.
  • Fit existing knowledgebases without rewriting wiki links or note structure.
  • Let multiple agents coordinate through explicit artifacts instead of raw logs.
  • Stay local, inspectable, and repo-friendly.

Install Or Try

Packaging metadata is included for the public owledge console script. Until a package is published, use a source checkout:

python tools/owledge.py --help

Fastest proof path:

python tools/owledge.py quickstart --target .agent-control/tmp/owledge-five-minute-demo
python tools/owledge.py install-addon --project-root .agent-control/tmp/owledge-five-minute-demo --addon launch-demo-kit
python tools/agent_memory_cli.py --project-root .agent-control/tmp/owledge-five-minute-demo build-memory-index

Expected result: the demo project contains evidence, a next-agent handoff, and a static proof report. Full walk-through: Try Owledge in 5 minutes.

Quickstart Paths

0. Use Only The Principles Or Skills

For the smallest setup, do not install anything. Tell an agent to follow the Owledge principles or use skills/agent-memory-principles:

Follow Owledge principles: keep Markdown canonical, preserve existing files,
write evidence-linked plans and handoffs, use stable frontmatter ids and typed
edges, keep raw sessions private, and promote only reviewed memory.

This path is the default for existing systems, solo users, and quick adoption.

1. Add Owledge To A Project

From your local Owledge clone:

python tools/owledge.py init-project --target /path/to/your-project

This is the primary setup path. It adds project-local Markdown memory and Python tools without changing the host framework, package manager, or source tree.

Best next read: Project quickstart

2. Add Owledge To A Knowledgebase

Add Owledge as a small additive module inside an existing vault:

python tools/owledge.py add-kb-module --knowledgebase-root /path/to/your/vault

Best next read: Drop-in agent integration guide

3. Check An Existing Install

Verify any initialized project:

python tools/owledge.py doctor --project-root /path/to/your-project

Optional: Plugin / Harness Setup

Use the ready-to-install Cowork / Claude-compatible plugin bundle:

plugins/agent-memory-cowork/

Best next read: Plugin install guide

Optional: Project Snapshot Kit

Install the optional project cockpit add-on only when a project should generate reusable snapshots and static HTML pages:

python tools/owledge.py install-addon --project-root . --addon project-snapshot-kit
python tools/owledge.py project-snapshot --project-root .

The generation command asks before creating Markdown snapshots or HTML pages unless explicit non-interactive flags are used.

Optional: Launch Add-ons

Launch add-ons improve distribution readiness without changing the core memory contract:

python tools/owledge.py install-addon --project-root . --addon launch-demo-kit
python tools/owledge.py install-addon --project-root . --addon trust-readiness-kit
python tools/owledge.py install-addon --project-root . --addon runtime-conformance-kit
python tools/owledge.py install-addon --project-root . --addon pi-proof-kit

Additional proof add-ons are available for teams that need TypeScript CI validation, benchmark charts, decision traceability, cross-project reuse, multi-agent handoffs, or poweruser positioning:

python tools/owledge.py install-addon --project-root . --addon ts-adapter-kit
python tools/owledge.py install-addon --project-root . --addon pilot-benchmark-kit
python tools/owledge.py install-addon --project-root . --addon enterprise-context-benchmark-kit
python tools/owledge.py install-addon --project-root . --addon decision-trace-kit
python tools/owledge.py install-addon --project-root . --addon cross-project-hub-kit
python tools/owledge.py install-addon --project-root . --addon swarm-coordination-kit
python tools/owledge.py install-addon --project-root . --addon poweruser-positioning-kit

Decision Guide

Use the smallest integration that solves the current problem.

Path Use when Adds
Principles-only / Skills An agent needs the memory rules inside an existing workflow Instructions only
Project-local kit A repo needs durable plans, evidence, handoffs, indexes, and validation Local Markdown memory and Python tools
Knowledgebase module An existing Markdown or Obsidian-style vault should be scanned without migration Additive module or mapped indexes
Runtime adapter Session capture, hooks, or runtime handoffs are needed Optional plugin files and hooks
Planning layer skill A project already has its own AGENTS.md or agent memory and should keep it Opt-in Owledge planning, evidence, handoff, and context hygiene rules
Add-ons Demo, trust, conformance, PI proof, TS eval, benchmark, decision trace, cross-project hub, swarm coordination, or positioning evidence is needed Optional docs, fixtures, tools, and generated views

Detailed guide: Integration decision guide.

Before / After

Without Owledge:

  • a plan lives in chat
  • evidence is scattered across notes and commits
  • a second agent has to reconstruct the project state
  • handoffs depend on whoever remembers the context

With Owledge:

  • plans live in Markdown
  • evidence paths are explicit
  • handoffs and reviews are durable artifacts
  • future agents can resume from scoped files instead of entire chat logs

Harness Support

Owledge is a memory layer around agent runtimes. It does not replace the runtime or its execution methodology.

Harness Current shape Install path
Principles-only coding agents First-class support Instructions or agent-memory-principles skill
Codex Local adapter support Local CLI, skills, optional plugin adapter
Claude Code Local adapter support Skill/plugin copy path plus project-local memory rules
Cowork / Claude-compatible Local adapter support plugins/agent-memory-cowork/
OpenCode-style agents Instruction-based support Repo-link integration via AGENTS.md and local scripts
Existing Markdown / Obsidian KBs Primary supported path tools/build_kb_module.py or agent-memory-map.json
PI agents Advanced optional path Candidate-only QA, workspace checks, and intelligence artifacts

Full matrix: Harness and plugin matrix

Integration Model

Mode What changes Best fit
Principles-only Agent instructions adopt the Owledge memory contract without adding a plugin; no plugin, generator, wrapper, or OS-specific setup is required Existing coding agents and mature repos
Project-local kit Adds PROJECT_CONTEXT.md, agent-memory/, local Python tools, and optional runtime adapter files Coding projects that want durable memory in-repo
Knowledgebase module Adds an Owledge-owned module or mapped folders beside an existing Markdown KB Obsidian-style vaults and LLM wikis
Runtime adapter Adds optional plugin hooks and commands around the same Markdown source of truth Claude/Cowork/Codex-compatible local workflows

Performance And Token Model

Owledge is designed to avoid the "load the whole vault into context" failure mode.

flowchart LR
    A["Existing repo or vault"] --> B["Metadata-first scan"]
    B --> C["Paths, titles, hashes, refs"]
    C --> D["Scoped context pack"]
    D --> E["Agent loads only relevant source files"]
    E --> F["Plan, evidence, handoff, review"]
Area Current release behavior
KB scan Metadata-first by default; no body-copy migration
Token strategy Paths and refs first, full bodies only on demand
Write policy Additive module or mapped writes; existing notes unchanged by default
Scale guard --max-files, excluded generated dirs, truncation reporting
Benchmarks Reproducible local harness included under benchmarks/

Benchmarks and scale notes: Performance and scale notes

Not This

Owledge is not:

  • a hosted platform
  • a vector database
  • an RBAC or enterprise policy system
  • a replacement for Superpowers or Ponytail
  • a requirement to migrate your existing vault taxonomy

It is a local/project utility layer for durable memory, planning discipline, and agent coordination.

Launch Extensions

The core stays small. Broad-launch proof is handled by optional add-ons:

Add-on Purpose
launch-demo-kit Five-minute demo with evidence, handoff, and static proof report.
trust-readiness-kit Data-flow, threat model, security FAQ, and team checklist.
runtime-conformance-kit Read-only runtime contracts for Codex, Claude Code, and Cowork-compatible adapters.
pi-proof-kit Synthetic PI loop proving observe, detect, red-team, promote, and measure.
ts-adapter-kit Optional Node/TypeScript CI validation for the Markdown contract.
pilot-benchmark-kit Optional pilot benchmark summaries and static chart views.
enterprise-context-benchmark-kit Research-grade synthetic context/token benchmark with JSON data, charts, and HTML report.
decision-trace-kit Read-only JSON and HTML trace from memory records to decision tree.
cross-project-hub-kit Reviewed export map from project-local lessons, patterns, decisions, and summaries into a central reusable hub.
swarm-coordination-kit Role-lane templates for Codex, Claude Code, Hermes, and generic agent swarms without hard distributed locking.
poweruser-positioning-kit Snapshot-first positioning scorecard for adjacent AI-agent tool categories.

Launch scoring and pass/fail criteria: Launch readiness rubric. Distribution path: Distribution and release.

Quality Gates

Release validation is scriptable and local:

python tools/owledge.py finalization-gates --project-root . --include-compliance
python tools/owledge.py redteam-qa --project-root .

Public docs are checked separately for encoding, anchors, links, plugin/install consistency, and benchmark asset presence:

python tools/owledge.py test public-docs --project-root .
python tools/owledge.py test quality-ratchet --project-root .
python tools/owledge.py test launch-readiness --project-root .

Documentation

Start here: Documentation index

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

owledge-0.6.0.tar.gz (345.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

owledge-0.6.0-py3-none-any.whl (219.8 kB view details)

Uploaded Python 3

File details

Details for the file owledge-0.6.0.tar.gz.

File metadata

  • Download URL: owledge-0.6.0.tar.gz
  • Upload date:
  • Size: 345.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for owledge-0.6.0.tar.gz
Algorithm Hash digest
SHA256 525209c3d41d3af5ed8cd251a75aa285d0d0155db9c097bff804b716b5665933
MD5 ebd188403aca77a4a0bece9ba5e6e1f9
BLAKE2b-256 aa41601abc4c3d0db648050cd87d586bc787b8e86a7930d692e2b0b068e8d8d8

See more details on using hashes here.

Provenance

The following attestation bundles were made for owledge-0.6.0.tar.gz:

Publisher: release.yml on elmokirk/owledge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file owledge-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: owledge-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 219.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for owledge-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c44951af619832b4068ce4d0fc5ba10a43439455754a221fb95f59e69418494
MD5 ed4ef2b4e9ebbc53d75412c28d0ab668
BLAKE2b-256 ceedf3443b5a4eb8eebd468734c2df5fe69293c1a75391481ac7d29075c729af

See more details on using hashes here.

Provenance

The following attestation bundles were made for owledge-0.6.0-py3-none-any.whl:

Publisher: release.yml on elmokirk/owledge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page