Back to the catalog

Knowledge Bundle — `memory/`

Bundle OKF 0.1 · 5 conceitos · duyet/kb

Open source Repository Open in the app JSON README (API)

About

# Knowledge Bundle — `memory/`

Duyet's shared brain, a conformant [OKF v0.1](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) bundle. Slugs are stable; cross-links are Obsidian wikilinks (resolved by `name:`).

Agent-facing index: `MEMORY.md`. Graph viewer: `kb viz`.

## Groups

- [`feedback/`](feedback/)
- [`projects/`](projects/)
- [`reference/`](reference/)
- [`topics/`](topics/)
- [`user/`](user/)

Details

Kind
OKF bundles
Topic
AI, RAG & memory
Publisher
duyet
Origin
okf_github
Category
dados
Version
0.1
Stars
2
Last push
2026-09-04T18:39:07Z
Repository state
ativo
Language
HTML
Added
2026-09-08 09:02:43
Updated
2026-09-08 09:02:43
Origin id
duyet/kb:memory/index.md

README

# kb — the shared brain

A single, plain-text knowledge base that every coding agent (Claude Code, Codex,
Hermes, OpenClaw, …) and every repo reads from and writes to — the **root source
of truth for agent memory**. Write a fact once; every agent on every device uses it.

Public repo: general, durable, *public-facing* knowledge only — never secrets,
tokens, internal hosts, or anything you wouldn't post on a blog.

## Design

Simple and hackable (Zettelkasten-style): plain markdown, no database (agents
`grep` it); **atomic notes** (one fact per file); **index-first** (`MEMORY.md`
loaded before anything else); **linked** via `[[wikilinks]]` + `tags` (browsable
as a graph in Obsidian); **self-healing** via the `DREAM.md` consolidation pass.

## Structure

```
kb/
├── AGENTS.md      ← canonical protocol for ALL agents (read/write/dream rules)
├── CLAUDE.md      ← thin pointer to AGENTS.md
├── DREAM.md       ← memory-consolidation ("dream") protocol
├── MEMORY.md      ← master index, one line per note — load first
├── raw/           ← capture inbox (raw/inbox/<date>.md) + ground-truth sources
├── memory/        ← the OKF v0.1 bundle: notes nested under <group>/…
│   ├── index.md   ← generated OKF listing (okf_version: "0.1") — run `kb gen`
│   ├── log.md     ← generated change history (newest-first)
│   ├── _TEMPLATE.md  ← the note standard
│   ├── user/ feedback/ reference/ projects/  ← memory-layer groups
│   └── topics/<domain>/  ← cloudflare, llm-agents, web, ci, workflow, standards
├── skills/        ← kb-memory, kb-dream (installable Claude Code skills)
├── scripts/       ← bootstrap / install / kb CLI / sync / lint / okf_gen.py
├── viz.html       ← generated self-contained graph viewer — run `kb viz`
└── .agent/        ← state.json (ingested files + tasks)
```

This repo **is a conformant [OKF v0.1](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) bundle** — `memory/` is the bundle root; each concept is one `.md` carrying `type` (an OKF custom field). `index.md`/`log.md`/`viz.html` are generated; re-run `kb gen` (or `kb viz` to also open the viewer) after writing notes. See `tech-okf-bundle` note / OKF layout for the full alignment.

Every note follows `memory/_TEMPLATE.md` and must pass `kb lint`. Format spec in
`AGENTS.md`.

## How it works

- **Read in:** `kb index` (= `MEMORY.md`), open the relevant notes; fetch a note's
  `sources:` (`llms.txt`) for deeper detail.
- **Write out:** unsure it's durable → `kb capture "note"` (lands in `raw/inbox/`);
  known keeper → a standard note in `memory/<group>/…`. Then
  `kb lint && kb gen && kb sync` (regenerate the OKF `index.md`/`viz.html`).
- **Dream:** periodically (or `/loop`) run `DREAM.md` — it ingests the inbox + raw
  sources into clean notes, dedupes, refreshes stale notes from `sources:`, rebuilds
  the index, and syncs.

## Install (any machine)

```bash
curl -fsSL https://raw.githubusercontent.com/duyet/kb/main/scripts/bootstrap.sh | bash
```

Minimal footprint — the changes to your machine are: **link the skills** into
`~/.claude/skills`, **wire the reflex** into each installed agent's global config
(a small marked, removable block), and a **PATH line** you add for the `kb` CLI
(the script stays in the repo, nothing is copied):

```bash
export PATH="$HOME/kb/bin:$PATH"     # add to ~/.zshrc or ~/.bashrc
```

**Wiring is multi-agent and adaptive** — it only touches agents that are present:
Claude Code (`~/.claude/CLAUDE.md`+`AGENTS.md`), Codex (`~/.codex/AGENTS.md`),
opencode (`~/.config/opencode/AGENTS.md`), hermes (`~/.hermes/SOUL.md`), openclaw
(`~/.openclaw/CLAUDE.md`). Toggle with `kb wire on|off`; skip at install with
`KB_NO_WIRE=1`.

No cron, no other edits. Opt in to background sync with `kb autosync on`. Remove
everything with `scripts/uninstall.sh` (unlinks + unwires; repo untouched). Env:
`KB_DIR`, `KB_REPO`, `CLAUDE_SKILLS_DIR`. Verify: `kb root`.

## CLI

```bash
kb capture "rough note"   # → raw/inbox/<today>.md
kb ingest <file>          # add a source doc to raw/
kb index | kb lint | kb sync | kb dream | kb root
kb autosync on|off|status # opt-in */15min sync cron
```

Skills `kb-memory` (read/write protocol) and `kb-dream` (consolidation) install to
`~/.claude/skills/` and resolve the KB via `$KB_DIR` / `kb root`, so they work
wherever kb is cloned. They're **canonical in this repo** — install via the symlink
installer (auto-updates on `git pull`). To share a skill without shipping your
memory, mirror `skills/` into a separate plugins repo (path-agnostic via `KB_DIR`).

## Quality gates (lint + secret scan)

`scripts/lint.sh` validates every note (required frontmatter, `name`==filename,
type-token filename prefix, `[[wikilink]]` resolution, `MEMORY.md` index
coverage) and runs the public-repo secret/PII scan from `AGENTS.md` §3 over the
notes, `raw/inbox/`, and `MEMORY.md`. Run it directly with `kb lint` (or
`KB_DIR=$PWD bash scripts/lint.sh`).

Two enforcement points share it:

- **Local pre-commit hook** (committed, opt-in per clone):

  ```bash
  git config core.hooksPath githooks
  ```

  `githooks/pre-commit` then runs the lint and blocks any commit that fails.

- **CI** — `.github/workflows/lint.yml` runs `scripts/lint.sh` and
  `gitleaks detect --no-git --config .gitleaks.toml` on every push and PR.

## Website

The knowledge base website at [kb.duyet.net](https://kb.duyet.net) is rendered
by the [`apps/kb/`](https://github.com/duyet/monorepo/tree/master/apps/kb) app
in the monorepo, which consumes this repo as a git submodule. No website code
lives here — only `.md` knowledge files and agent skills.

## Scope

Public, general, durable knowledge only. **Never** here: secrets, SSH hosts,
internal/employer-confidential details, anything user-private — those stay in a
repo's local kb or the agent's private per-project memory.

More