diff --git a/README.md b/README.md index b9739dd..238bf59 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,16 @@ Obelisk -Every past session, subagent, and workflow — searchable in natural language. - [![stars](https://img.shields.io/github/stars/tommy0103/obelisk?style=flat-square)](https://github.com/tommy0103/obelisk/stargazers) [![version](https://img.shields.io/github/v/tag/tommy0103/obelisk?label=version&style=flat-square)](https://github.com/tommy0103/obelisk/releases) [![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE) +Every past session, subagent, and workflow -- queryable by your agent. + +**Humans should not browse session history. Agents should query it.** + - - -
@@ -24,18 +23,37 @@ Every past session, subagent, and workflow — searchable in natural language.

Ask in plain language. The agent writes the query, runs it, answers.

---- +## Not a session browser + +Most history tools help humans find old chats. + +Obelisk is built for agents. It exposes past work as structured data: sessions, +messages, tool calls, subagents, workflows, file history, failures, and parent +chains. The agent writes the query, runs it locally, and answers in plain language. + +You don't manage history. You ask questions about past work. + +## Why Obelisk + +| Session library | Obelisk | +|---|---| +| Find an old chat | Answer a question about past work | +| Human browses snippets | Agent writes and runs a query | +| Search result list | Structured context and reasoning | +| Sessions as documents | Sessions as queryable memory | +| Good for recall | Good for investigation | ## What you can ask ``` -/obelisk 上次那个 auth 的 bug 我怎么修的 -/obelisk 哪些文件这周被反复修改 -/obelisk 最近 workflow 跑出来什么结果 -/obelisk 我让 subagent 做过哪些代码 review +/obelisk 上次 auth bug 最后到底改了哪些文件,为什么这么改 +/obelisk 这个文件最近在哪些 sessions 里被反复修改 +/obelisk 找出最近失败的 tool calls,它们分别发生在哪些任务里 +/obelisk 那个 review workflow 的 subagents 各自结论是什么 +/obelisk 我之前有没有试过这个方案,结果为什么放弃了 ``` -Anything Claude Code has done before — sessions, tool calls, subagents, workflows — is indexed and searchable. Ask in your own words. +Anything Claude Code has done before -- sessions, tool calls, subagents, workflows -- becomes structured, queryable memory. Ask in your own words. ## Install @@ -53,24 +71,11 @@ Then in any Claude Code session: First run builds the index (~5 seconds for 100 sessions). After that it rebuilds incrementally. -### Requires +### Requires - Node.js 22+ (uses built-in node:sqlite with FTS5) - Claude Code with skills support. -## What gets indexed - -| Layer | Source | What's captured | -|-------|--------|----------------| -| **Sessions** | `/.jsonl` | Title, project, timestamps, git branch | -| **Messages** | user + assistant turns | Full text, model, token usage, parent chain | -| **Tool calls** | every tool invocation | Tool name, input, file paths touched | -| **Subagents** | `subagents/agent-.jsonl` | Agent type, description, full conversation | -| **Workflows** | `workflows/wf_.json` | Script, structured result, agent count | -| **Workflow agents** | `subagents/workflows/wf_/` | Per-agent transcripts linked to workflow | - -Full-text search via FTS5 covers all message text across every layer. - ## How it works ``` @@ -83,7 +88,11 @@ Runs it via node runtime.mjs --query