zettelkasten-cli 0.5.0

CLI to merge Vim and Obsidian Zettelkasten

Zettelkasten CLI

A bespoke CLI for my Neovim + Obsidian Zettelkasten written in Python.

Installation

From PyPI

pip install zettelkasten-cli

Or with uv:

uv tool install zettelkasten-cli

From Source

git clone https://github.com/mischavandenburg/zettelkasten-cli.git
cd zettelkasten-cli
uv sync
uv run zk --help

Configuration

Environment Variables

Variable	Required	Default	Description
ZETTELKASTEN	Yes	-	Path to your Zettelkasten root directory
ZETTELKASTEN_INBOX_DIR	No	0 Inbox	Directory for new notes (relative to root)
ZETTELKASTEN_DAILY_DIR	No	periodic-notes/daily-notes	Directory for daily notes (relative to root)
ZETTELKASTEN_WEEKLY_DIR	No	periodic-notes/weekly-notes	Directory for weekly notes (relative to root)
ZETTELKASTEN_DAILY_TEMPLATE	No	zk/daily.md	Path to daily note template (relative to root)
ZETTELKASTEN_WEEKLY_TEMPLATE	No	zk/weekly.md	Path to weekly note template (relative to root)
ZETTELKASTEN_EDITOR	No	nvim	Editor command (nvim, vim, hx, code, etc.)
ZETTELKASTEN_NVIM_ARGS	No	+ normal Gzzo	Arguments passed to Neovim when opening notes
ZETTELKASTEN_NVIM_COMMANDS	No	:NoNeckPain	Comma-separated Neovim commands to run on open

Add to your shell profile (e.g., ~/.bashrc or ~/.zshrc):

export ZETTELKASTEN="$HOME/Documents/Zettelkasten"

# Optional: customize inbox directory
export ZETTELKASTEN_INBOX_DIR="Inbox"

# Optional: customize periodic notes directories
export ZETTELKASTEN_DAILY_DIR="daily-notes"
export ZETTELKASTEN_WEEKLY_DIR="weekly-notes"

# Optional: customize template locations
export ZETTELKASTEN_DAILY_TEMPLATE="templates/daily.md"
export ZETTELKASTEN_WEEKLY_TEMPLATE="templates/weekly.md"

# Optional: use a different editor
export ZETTELKASTEN_EDITOR="hx"  # or vim, code, etc.

# Optional: customize Neovim behavior (only applies when using nvim)
export ZETTELKASTEN_NVIM_ARGS="+ normal Gzzo"
export ZETTELKASTEN_NVIM_COMMANDS=":NoNeckPain,:set wrap"

Default Directory Structure

With default settings, the CLI expects the following structure:

$ZETTELKASTEN/
├── 0 Inbox/              # New notes are created here
├── periodic-notes/
│   ├── daily-notes/      # Daily notes (YYYY-MM-DD.md)
│   ├── weekly-notes/     # Weekly notes (YYYY-Www.md)
│   ├── monthly-notes/    # (not yet implemented)
│   └── yearly-notes/     # (not yet implemented)
└── zk/
    ├── daily.md          # Template for daily notes
    └── weekly.md         # Template for weekly notes

All paths are configurable via environment variables.

Templates

Templates are read from the configured template paths. If templates don't exist, minimal defaults are used.

Usage

zk [OPTIONS] COMMAND [ARGS]...

Options:

• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell.
• --help: Show this message and exit.

Commands:

• day: Open daily note or create if it doesn't exist.
• week: Open weekly note or create if it doesn't exist.
• new: Create a new note with the provided title.

zk day

Open daily note or create if it doesn't exist.

zk day [OPTIONS]

zk week

Open weekly note or create if it doesn't exist.

zk week [OPTIONS]

zk new

Create a new note with the provided title. Will prompt if no title given. Adds Obsidian markdown link to the daily note.

zk new [OPTIONS] [TITLE]

Arguments:

• [TITLE] - Note title (optional, will prompt if not provided)

Options:

• --vim: Indicates input is coming from Neovim. Suppresses rich output.

Development

# Install dependencies
uv sync

# Run linter
uv run ruff check .

# Run tests
uv run pytest

# Build package
uv build

Releasing

This project uses release-please for automated releases.

1. Use Conventional Commits for commit messages:

   • feat: for new features (bumps minor version)
   • fix: for bug fixes (bumps patch version)
   • feat!: or fix!: for breaking changes (bumps major version)

2. When commits are pushed to main, release-please creates/updates a release PR

3. Merging the release PR automatically:

   • Creates a GitHub release with changelog
   • Publishes to PyPI