← 返回
未分类 中文

Zettelkasten note tool

Create, manage, and operate a Zettelkasten slip-box note system using the zk.py CLI script. Use this skill whenever a user wants to build or use a Zettelkast...
使用zk.py命令行脚本创建、管理和操作Zettelkasten卡片盒笔记系统,适用于用户构建或使用Zettelkast的场景。
goog goog 来源
未分类 clawhub v1.0.0 1 版本 100000 Key: 无需
★ 0
Stars
📥 319
下载
💾 0
安装
1
版本
#latest

概述

znote: Zettelkasten CLI Note Manager

A single-file Python CLI tool (zk.py) implementing the full Zettelkasten method as described in the Desktop Commander / Obsidian Practical Setup Guide. No dependencies beyond Python 3.8+ stdlib. Creates and manages a local markdown vault compatible with Obsidian.

Inputs

  • Python 3.8+ (no pip installs needed)
  • Optional: ZK_VAULT environment variable to set vault location (default: ~/Zettelkasten)
  • Optional: EDITOR environment variable for note editing (default: nano)

Vault Structure

~/Zettelkasten/
  00-Inbox/        ← fleeting notes (quick captures)
  10-Literature/   ← one note per source, in your own words
  20-Permanent/    ← atomic notes, one idea, fully linked
  30-MOC/          ← Maps of Content (navigation layers)
  40-Templates/    ← markdown templates for each type

Workflow

Step 1: Deliver the script

Copy zk.py to /mnt/user-data/outputs/zk.py and present it to the user via present_files. Also deliver README.md.

Step 2: User installs

chmod +x zk.py
cp zk.py ~/.local/bin/zk        # optional: make globally available
export ZK_VAULT=~/Zettelkasten  # add to ~/.bashrc or ~/.zshrc

Step 3: Initialise vault

python3 zk.py init
# Creates all 5 folders + 4 markdown templates

Step 4: Daily workflow

Capture (fleeting note, no friction):

zk new fleeting

Process inbox weekly (flags notes older than 7 days):

zk inbox

Write permanent notes (one atomic idea per note):

zk new permanent "Claim written as a full sentence"

Link notes — edit the ## Connections section and add [[note-stem]] links.

Promote fleeting → permanent:

zk promote "fragment of title"

Generate Map of Content when a topic has 8+ notes:

zk moc "Topic Name"

Step 5: Maintenance commands

zk links                    # find orphaned notes (no links in/out)
zk links "note title"       # show forward + backlinks for one note
zk graph                    # ASCII link graph of entire vault
zk stats                    # counts, top tags, orphan count
zk search "query"           # full-text search with highlights
zk list --folder permanent  # list notes in a specific folder
zk list --tag psychology    # filter by tag

Output

  • zk.py — single-file Python CLI, ~400 lines, no dependencies
  • README.md — full usage guide with workflow and tips
  • A local markdown vault fully compatible with Obsidian

Note Types & Templates

TypeFolderFilename patternTemplate fields
------------
Fleeting00-Inbox/{timestamp}.mdcreated, status
Literature10-Literature/{date}-{slug}.mdcreated, status, source, author, tags
Permanent20-Permanent/{date}-{slug}.mdcreated, status, tags, source, Connections, Source
MOC30-MOC/MOC-{slug}.mdcreated, status, tags, linked notes

Key Method Rules (from the guide)

  • One idea per permanent note — if a second idea appears, create a new note and link
  • Titles are claims, not topics: "Attention is a finite resource" not "Attention"
  • Link from day one — every permanent note needs at least one [[link]]
  • Tags supplement links — use broad tags (#psychology), not fine-grained ones
  • MOCs emerge late — only create when navigation actually becomes difficult
  • Inbox rule — fleeting notes must be processed within 7 days

Notes / Edge Cases

  • The script uses [[double-bracket]] wiki-link syntax identical to Obsidian — vaults are fully interoperable
  • Link targets are matched by filename stem (case-insensitive)
  • zk graph marks missing link targets with ⇢? in red
  • --no-edit flag on new, promote, moc skips opening the editor (useful for scripting)
  • ZK_VAULT env var overrides --vault flag and default path
  • The zk promote command fuzzy-matches on filename and note body content
  • Templates folder is excluded from stats/orphan counts automatically

版本历史

共 1 个版本

  • v1.0.0 当前
    2026-05-07 10:58 安全 安全

安全检测

腾讯云安全 (Keen)

安全,无风险
查看报告

腾讯云安全 (Sanbu)

安全,无风险
查看报告

🔗 相关推荐

knowledge-management

web-tools-guide

user_ec205dbb
MANDATORY before calling web_search, web_fetch, browser, or opencli. Contains required error-handling procedures (web_se
★ 66 📥 159,520
knowledge-management

Summarize

paudyyin
智能摘要工具,自动为长文本、文档、网页生成摘要,提取要点与关键词,支持自定义摘要长度。
★ 957 📥 518,412
knowledge-management

Obsidian

steipete
操作 Obsidian 仓库(纯 Markdown 笔记)并通过 obsidian-cli 自动化。
★ 444 📥 104,860