A CLI note-taking tool inspired by Zettelkasten
Project description
🧩 Shard
Shard is a terminal companion for your Obsidian.md vault.
Quickly create notes, access daily entries, search, and push your vault to Git – all from the command line.
🚀 Features
- 📄 Create new notes with frontmatter
- 📅 Manage daily notes
- 🔍 Search notes by title
- 🏷️ List tags across your vault
- ⛓️ View backlinks to any note
- ☁️ Push changes to a Git repo with one command
📦 Installation
Using pip (via PyPI):
pip install shard
Using Poetry (local development):
git clone https://codeberg.org/WolfQuery/shard
cd shard
poetry install
🔧 Usage
shard new "My Project Idea" --tags project,cli
shard daily
shard search "zettel"
shard tags
shard backlinks zettelkasten.md
shard push
You can also pass a custom commit message:
shard push -m "added new zettel on memory systems"
📂 Vault Setup
By default, shard looks for your Obsidian vault in ~/vault/.
You can customize this in a future config file at:
~/.config/shard/config.toml
💻 Requirements
- Python 3.9+
- Git (installed and initialized in your vault)
- Optional:
fzffor fuzzy search
📖 License
CC BY-NC-SA 4.0 © 2025 WolfQuery
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
shard_cli-0.1.0.tar.gz
(7.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters