Skip to main content

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: fzf for fuzzy search

📖 License

CC BY-NC-SA 4.0 © 2025 WolfQuery

Project details


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)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shard_cli-0.1.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file shard_cli-0.1.0.tar.gz.

File metadata

  • Download URL: shard_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.4

File hashes

Hashes for shard_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b74618a0be65e49de2c4d7a36b4f624198eb47e185785fe7a7bcd7b6aa2c395b
MD5 1732bf719dd39df562a9f0980ecd30ea
BLAKE2b-256 d6644abe2a11543d4c71980147d5e36cc5f5a09be8bd46478577f6190ce90dfe

See more details on using hashes here.

File details

Details for the file shard_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: shard_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.4

File hashes

Hashes for shard_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d53dc5221f458fb5742fd5e42fb243ad415e6da5c88d6f697225e1bb7172c969
MD5 1af3415a49b33b2ccf2eaa5d6b928bd7
BLAKE2b-256 8aac92890d85400663877bd9eff69b24b5c040916220d9f66c2d57b4463ec483

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page