Skip to content

Commit 6784d9e

Browse files
committed
release: promote v2.0.0 public artifact
1 parent cb93ff6 commit 6784d9e

316 files changed

Lines changed: 44271 additions & 37378 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude-plugin/marketplace.json

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,22 @@
11
{
2-
"$schema": "https://anthropic.com/claude-code/marketplace.schema.json",
2+
"description": "Audited public distribution channel for claude-obsidian",
33
"name": "agricidaniel-claude-obsidian",
44
"owner": {
5-
"name": "AgriciDaniel",
6-
"url": "https://github.com/AgriciDaniel"
7-
},
8-
"metadata": {
9-
"description": "claude-obsidian: a self-organizing AI second brain for Obsidian + Claude Code by AgriciDaniel. A persistent, compounding wiki vault of plain Markdown you own, based on Karpathy's LLM Wiki pattern.",
10-
"version": "1.9.2"
5+
"name": "AgriciDaniel"
116
},
127
"plugins": [
138
{
14-
"name": "claude-obsidian",
15-
"source": "./",
16-
"description": "Claude + Obsidian knowledge companion. v1.7 \"Compound Vault\" + v1.8 methodology modes close 5 of 5 priority gaps from the May 2026 compass artifact. Ships: substrate alignment with kepano/obsidian-skills, default Obsidian CLI transport, hybrid retrieval (Anthropic Sept 2024 contextual retrieval pattern: BM25 + cosine rerank), per-file advisory locking for multi-writer safety, pre-commit verifier agent, AND methodology modes (LYT / PARA / Zettelkasten / Generic) — first-class organizational support no other Claude+Obsidian competitor offers. v1.7.x audit fully closed; 50-query retrieval benchmark verified at +32pp top-1 / +41% error-reduction vs v1.6 baseline. Optional DragonScale Memory extension. Pairs with kepano/obsidian-skills (recommended) for canonical Obsidian primitives.",
17-
"version": "1.9.2",
189
"author": {
1910
"name": "AgriciDaniel",
2011
"url": "https://github.com/AgriciDaniel"
2112
},
13+
"description": "Local-first Agent Skills package and Claude Code plugin for source-cited Obsidian knowledge bases. Includes recoverable transactions, deterministic lint and retrieval, provenance ledgers, explicit vault adoption, offline-first capture foundations, and methodology modes.",
2214
"homepage": "https://github.com/AgriciDaniel/claude-obsidian",
15+
"license": "MIT",
16+
"name": "claude-obsidian",
2317
"repository": "https://github.com/AgriciDaniel/claude-obsidian",
24-
"license": "MIT"
18+
"source": "./"
2519
}
26-
]
20+
],
21+
"version": "2.0.0"
2722
}

.claude-plugin/plugin.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "claude-obsidian",
3-
"version": "1.9.2",
4-
"description": "Claude + Obsidian knowledge companion. Sets up a persistent, compounding wiki vault (Karpathy's LLM Wiki pattern). v1.7 \"Compound Vault\" + v1.8 methodology modes close 5 of 5 priority gaps from the May 2026 compass artifact. Ships: substrate alignment with kepano/obsidian-skills, default Obsidian CLI transport, hybrid retrieval (contextual prefix + BM25 + cosine rerank per Anthropic's Sept 2024 research), per-file advisory locking for multi-writer safety, pre-commit verifier agent, AND methodology modes (LYT / PARA / Zettelkasten / Generic) for first-class organizational support no other Claude+Obsidian competitor offers. v1.7.x audit closure: every BLOCKER + HIGH + MEDIUM + LOW finding from the v1.7.0 audit is CLOSED or DEFERRED-with-rationale. Optional DragonScale Memory extension (log folds, deterministic addresses, semantic tiling lint, boundary-first autoresearch).",
3+
"version": "2.0.0",
4+
"description": "Local-first Agent Skills package and Claude Code plugin for source-cited Obsidian knowledge bases. Provides explicit vault initialization and adoption, recoverable operation transactions, deterministic lint and retrieval, provenance ledgers, offline-first capture foundations, and optional methodology modes. User vaults stay outside the plugin cache; network and destructive actions require explicit consent.",
55
"author": {
66
"name": "AgriciDaniel",
77
"url": "https://github.com/AgriciDaniel"

.cursor/rules/claude-obsidian.mdc

Lines changed: 17 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,32 @@
11
---
2-
description: claude-obsidian: LLM Wiki Pattern for Obsidian vaults. Always-on context for any project pointed at this repo.
2+
description: Portable rules for the claude-obsidian product and user vault workflows.
33
globs:
4+
- "skills/**/SKILL.md"
5+
- "claude_obsidian/**/*.py"
46
- "wiki/**/*.md"
57
- ".raw/**/*"
6-
- "skills/**/SKILL.md"
78
alwaysApply: true
89
---
910

1011
# claude-obsidian
1112

12-
A Claude Code plugin and Obsidian vault that builds persistent, compounding knowledge bases using Andrej Karpathy's LLM Wiki pattern. This repo works with Cursor's AI through the cross-platform Agent Skills format.
13-
14-
## What This Project Is
15-
16-
- **Vault root**: contains `wiki/` (agent-generated knowledge) and `.raw/` (source documents: immutable)
17-
- **Hot cache**: `wiki/hot.md` (~500 tokens) holds recent session context
18-
- **Index**: `wiki/index.md` is the master catalog Claude reads first
19-
- **Skills**: 10 skills under `skills/<name>/SKILL.md` define ingest/query/lint/save/canvas/etc
20-
21-
## Skills Available
22-
23-
| Skill | When to use |
24-
|---|---|
25-
| `wiki` | Scaffold new vault, route to sub-skills |
26-
| `wiki-ingest` | Ingest a file, URL, or image: creates 8-15 wiki pages |
27-
| `wiki-query` | Answer questions from the wiki (Quick / Standard / Deep modes) |
28-
| `wiki-lint` | Health check: orphans, dead links, gaps |
29-
| `save` | File current conversation as a wiki note |
30-
| `autoresearch` | Autonomous research loop |
31-
| `canvas` | Create/edit Obsidian canvas files |
32-
| `defuddle` | Clean web pages before ingest |
33-
| `obsidian-markdown` | Obsidian syntax reference |
34-
| `obsidian-bases` | Obsidian Bases (.base files) |
35-
36-
Read the relevant `skills/<name>/SKILL.md` file when the user's request matches a skill's trigger phrases.
13+
Read `AGENTS.md` as the canonical contract. This repository is product source;
14+
mutable knowledge belongs in a separately resolved user vault.
3715

38-
## Critical Conventions
16+
- Discover workflows from `skills/<name>/SKILL.md`.
17+
- Resolve vaults explicitly; never use the plugin/product directory by default.
18+
- Read a selected vault's bounded `wiki/hot.md` at session start when present.
19+
- Treat raw source payloads as create-only.
20+
- Have parallel workers draft; apply one recoverable operation transaction.
21+
- Keep queries and lint read-only. Put persistence or repair in a separate
22+
reviewed operation.
23+
- Require consent for network egress, destructive changes, and Git checkpoints.
3924

40-
1. **Never modify `.raw/`**. Sources are immutable
41-
2. **Read `wiki/hot.md` first** when starting a session (if it exists)
42-
3. **Use wikilinks** (`[[Note Name]]`) for all internal references in wiki pages
43-
4. **Frontmatter is flat YAML**. See `skills/wiki/references/frontmatter.md`
44-
5. **Append to `wiki/log.md`**, never edit past entries
45-
6. **Hot cache is overwritten** at session end (it's a cache, not a journal)
46-
47-
## Setup for Cursor
48-
49-
To make these skills first-class in Cursor, run:
25+
Preview and then install workspace-local skill links with:
5026

5127
```bash
52-
ln -s "$(pwd)/skills" .cursor/skills
28+
bash bin/setup-multi-agent.sh --host cursor --workspace "$PWD"
29+
bash bin/setup-multi-agent.sh --host cursor --workspace "$PWD" --apply
5330
```
5431

55-
Or use the bundled installer:
56-
57-
```bash
58-
bash bin/setup-multi-agent.sh
59-
```
60-
61-
## Cross-Reference
62-
63-
- Plugin: https://github.com/AgriciDaniel/claude-obsidian
64-
- Pattern: https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f
65-
- Related: https://github.com/kepano/obsidian-skills
32+
Public canonical: https://github.com/AgriciDaniel/claude-obsidian

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,12 @@ What you expected to happen instead.
1818
3. ...
1919

2020
## Environment
21-
- Plugin version: (e.g. v1.9.0)
21+
- Product version: (run `python3 scripts/claude-obsidian.py --version`)
2222
- Claude Code version: (run `claude --version`)
2323
- OS: (e.g. macOS 14.5, Pop!_OS 24.04, Windows 11)
2424
- Obsidian version: (if relevant)
25-
- Transport selected: (filesystem / obsidian-cli / mcp-obsidian — see `.vault-meta/transport.json`)
25+
- Vault selection source: (`doctor --vault <vault>` output, with private paths redacted)
26+
- Transport state: (`bash scripts/detect-transport.sh --peek --vault <vault>` output)
2627

2728
## Skill / agent / script involved
2829
Which surface is affected? (e.g. `/wiki-ingest`, `scripts/wiki-mode.py`, `agents/verifier.md`)
@@ -33,7 +34,8 @@ Paste relevant terminal output or error messages here.
3334
```
3435

3536
## What you tried
36-
- [ ] Ran `make test` — all 8 suites green? Yes / No
37+
- [ ] Ran the relevant regression test or `make test` — Yes / No
38+
- [ ] Confirmed the product repository and user vault are separate — Yes / No
3739
- [ ] Checked CHANGELOG for known issues at your version
3840
- [ ] Searched existing issues for similar reports
3941

.github/copilot-instructions.md

Lines changed: 15 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,19 @@
1-
# claude-obsidian: GitHub Copilot Instructions
1+
# claude-obsidian Copilot instructions
22

3-
This repository is a **Claude Code plugin and Obsidian vault** that builds persistent, compounding knowledge bases using Andrej Karpathy's LLM Wiki pattern. It is markdown-only. No build step, no compiled code, no runtime dependencies.
3+
Read `AGENTS.md` before proposing changes. The repository is an Agent Skills
4+
package, Claude Code adapter, standard-library Python core, and deterministic
5+
vault template—not the default live user vault.
46

5-
## Project Type
7+
When editing:
68

7-
- Agent Skills package (cross-platform Agent Skills standard)
8-
- Obsidian vault (interpretable by Obsidian directly)
9-
- Claude Code plugin (installable via marketplace)
9+
- Keep skill frontmatter to exactly `name` and single-line `description`.
10+
- Use Obsidian Flavored Markdown, flat YAML properties, and `YYYY-MM-DD` dates.
11+
- Never modify existing raw source payloads.
12+
- Route all logical knowledge mutations through one inspected operation bundle.
13+
- Keep workers draft-only and lint/query read-only.
14+
- Preserve vault path containment and product/vault separation.
15+
- Add hermetic regression tests for behavior changes and run `make test`.
16+
- Do not add secrets, private paths, unsupported capability claims, or duplicate
17+
command wrappers.
1018

11-
## Repository Layout
12-
13-
- `skills/`: 10 skills, each with a `SKILL.md` defining trigger phrases and instructions
14-
- `hooks/hooks.json`: Claude Code lifecycle hooks (SessionStart, PostCompact, PostToolUse, Stop)
15-
- `.claude-plugin/plugin.json`: plugin manifest
16-
- `wiki/`: generated knowledge base (Markdown files with YAML frontmatter)
17-
- `.raw/`: immutable source documents (never modify)
18-
- `_templates/`: Obsidian Templater templates
19-
- `_attachments/`: images and PDFs referenced by wiki pages
20-
21-
## Conventions Copilot Should Follow
22-
23-
When suggesting edits:
24-
25-
1. **Frontmatter is flat YAML** with plural keys: `tags`, `aliases`, `cssclasses`
26-
2. **Internal links are wikilinks**: `[[Note Name]]`, not Markdown links to `.md` paths
27-
3. **Dates are `YYYY-MM-DD`**, not ISO datetimes
28-
4. **`.raw/` is immutable**. Never suggest edits to anything under that path
29-
5. **`wiki/log.md` is append-only**, with new entries at the top
30-
6. **`wiki/hot.md` is overwritten** at session end, not appended to
31-
7. **Skills use only `name` and `description` in frontmatter**. No `allowed-tools`, no `triggers`, no `globs` (these are not part of the Agent Skills spec)
32-
8. **Custom callouts**: this vault defines `[!contradiction]`, `[!gap]`, `[!key-insight]`, `[!stale]` in `.obsidian/snippets/vault-colors.css`. These render only with that snippet enabled.
33-
34-
## When Editing Skills (`skills/<name>/SKILL.md`)
35-
36-
- Frontmatter: `name` (matches directory name) and `description` (single quoted line, max ~250 useful chars)
37-
- Body: short, imperative instructions. Reference files with backticks. Do not paste large code blocks unless they're essential.
38-
- Trigger phrases go in the `description` field, not in body or non-standard fields
39-
40-
## When Editing Hooks (`hooks/hooks.json`)
41-
42-
- Valid event names only: `SessionStart`, `Stop`, `PreToolUse`, `PostToolUse`, `PreCompact`, `PostCompact`, `UserPromptSubmit`
43-
- Hook types: `command` (shell), `prompt` (LLM), `http` (POST), `agent` (subagent)
44-
- `matcher` field uses regex against tool names for `PreToolUse`/`PostToolUse`
45-
- For `SessionStart`: matcher uses `startup`, `resume`, `clear`, or `compact`
46-
47-
## Cross-Reference
48-
49-
- Plugin: https://github.com/AgriciDaniel/claude-obsidian
50-
- Pattern source: https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f
51-
- Authoritative Obsidian-specific skills: https://github.com/kepano/obsidian-skills
19+
Public canonical: https://github.com/AgriciDaniel/claude-obsidian

.github/pull_request_template.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,17 @@ List the files and surfaces touched:
2020
- `scripts/<name>.py` — what changed
2121
- ...
2222

23-
## Six-cut self-review
23+
## Safety self-review
2424
- [ ] Read every file before changing it
2525
- [ ] New identifiers named for the next reader
2626
- [ ] Smallest unit that works (no speculative abstraction)
2727
- [ ] Deletions kept up with additions where applicable
2828
- [ ] New behavior has hermetic test coverage
2929
- [ ] New failure modes have explicit handling + undo plan
30+
- [ ] Product code and mutable user-vault state remain separate
31+
- [ ] Knowledge writes use one recoverable transaction; workers only draft
32+
- [ ] Network/destructive/external actions have explicit consent
33+
- [ ] Claims and capability maturity are evidence-backed
3034

3135
## Testing
3236
```
@@ -39,7 +43,7 @@ All tests passed.
3943
```
4044

4145
## Verifier
42-
For non-trivial changes, dispatch `agents/verifier.md` on the staged diff and paste its verdict:
46+
For non-trivial changes, dispatch `agents/verifier.md` on the declared worktree or path scope and paste its verdict:
4347

4448
- Verdict: SHIP / HOLD-FIX-FIRST / NEEDS-REWORK
4549
- BLOCKER: N / HIGH: N / MEDIUM: N / LOW: N

0 commit comments

Comments
 (0)