explaingit

wshuyi/zettel-builder

19PythonAudience · writerComplexity · 3/5LicenseSetup · moderate

TLDR

A Python tool that converts reading material into a network of atomic note cards using the Zettelkasten method, with AI-powered linking and value judgments, designed to run as a skill inside Claude Code or similar AI assistants.

Mindmap

mindmap
  root((repo))
    Commands
      ingest source material
      scan queue folder
      inspect clusters
      write draft outline
    Note Cards
      Single idea per card
      Value judgment required
      Candidate links listed
    Linking
      Embedding-based recall
      TF-IDF fallback
      AI final decision
    Tech Stack
      Python
      fastembed
      Claude Code skill
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Convert a long article or book chapter into a set of atomic idea cards with AI-assigned value judgments and candidate links to your existing notes.

USE CASE 2

Run the scan command on a queue folder of accumulated reading material to process everything in one pass and add cards to your Zettelkasten.

USE CASE 3

Use the inspect command to find clusters of related cards that are ready to be assembled into a draft article, with orphan and gap flagging.

USE CASE 4

Hand a ready cluster to the write command to get a structured draft outline you can pass to a writing assistant.

Tech stack

Pythonfastembed

Getting it running

Difficulty · moderate Time to first run · 30min

Designed to run as a slash-command skill inside Claude Code or a compatible AI assistant, requires filling in a voice-snapshot template before use.

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

In plain English

zettel-builder is a Python tool for turning raw reading material into a network of short, atomic note cards that can eventually be assembled into articles. It is designed to run inside AI coding assistants such as Claude Code, OpenClaw, Codex, or Hermes as an installable skill, meaning you invoke it through slash commands rather than running it as a standalone program. The core idea comes from the Zettelkasten method, a note-taking philosophy where each card captures a single idea that can stand alone even months later without needing its surrounding context. zettel-builder adds a required step on top of that: after splitting source material into cards, an AI agent must write a brief value judgment on each one, recording whether the author agrees, disagrees, or partially agrees with the idea and where the boundaries of that position lie. Cards without this judgment are considered unfinished. The tool provides four main commands. The ingest command takes a piece of source material and produces a batch of atomic cards, each with a value-realignment note and a list of candidate links to existing cards. The scan command works through a queue folder of accumulated material in one pass. The inspect command reviews the entire card pool to find clusters that are dense and varied enough to become an article, flagging orphan cards and gaps in coverage and optionally sending a Telegram notification when a cluster is ready. The write command takes a cluster and arranges it into a draft outline that can then be handed off to a separate writing skill. Linking between cards is handled by a combination of embedding-based recall (using fastembed with a lightweight Chinese-language model by default) and a TF-IDF fallback, but the final decision on whether two cards are genuinely connected is always made by the AI agent reading the full card text, not by a similarity threshold alone. The author describes this as intentionally expensive but necessary for accuracy. The repository ships with a voice-snapshot template that users must fill in with their own values and style rules before the value-realignment step works as intended. Scripts for embedding, clustering, and link candidates are included. The license is MIT.

Copy-paste prompts

Prompt 1
I want to use zettel-builder inside Claude Code to turn a research article into Zettelkasten note cards. Walk me through installing it as a skill and running the ingest command.
Prompt 2
How do I fill in the voice-snapshot template in zettel-builder so the value-realignment step captures my own opinions and writing style correctly?
Prompt 3
Show me how zettel-builder links note cards, when does it use embedding recall versus TF-IDF, and when does the AI agent make the final call?
Prompt 4
I have a folder of PDFs I've been reading. How do I use zettel-builder's scan command to process them all and add cards to my existing pool?
Prompt 5
How does zettel-builder's inspect command decide when a cluster of cards is ready to become an article? What counts as dense and varied enough?
Open on GitHub → Explain another repo

← wshuyi on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.