|0.1.2||Aug 31, 2022|
|0.1.1||Sep 8, 2021|
|0.1.0||Sep 8, 2021|
#835 in Command line utilities
A personal note management
cargo install zest-cli
- Create your config file:
# The path is ~/.config/zest/config.yml # List the paths you use here paths: - ~/notes/
- Add notes, the format is simple: markdown + metadata on top
--- # Metadata is in yaml # The tags you can to apply on this file tags: - foo - bar --- # Title It is recommended to add a title to your file You can link to other notes with normal markdown links: [mylink](myfile)
- Search with
zest queries are just
tantivy queries, with the following fields
that you can query:
file: the file containing the note (any part of the full path)
tag: the tags use for this note
ref: outgoing refs of the note
title: what is in the title
content: what is in the content
By default, search terms apply to the
zest search foo
zest search tag:foo
Notes refering to
zest search ref:foo
Notes refering to
foo and tagged
zest search ref:foo AND tag:bar
zest is a note management tool (or a knowledge base manager) that
allows you to create, search and display notes in your knowledge
It is meant to be used in a Zettelkasten-like workflow, where each note is it's own file (the full path is the note's id). You can then tag this file using metadata in your file, and add links to other notes.
CLI design is inspired by
notmuch a mail indexer, which does
only mail indexing and querying, just like zest.
Designed with scripting in mind, it is easy to add support for zest to your editor.
In summary, here are the design goals:
- Searching has to be fast
- Inserting and updating notes can be a bit longer
- Writing notes should use markdown
zest relies on
tantivy to perform the indexing and searching part.
Because of that, the indexing will greatly vary depending on the speed
of your SSD/HDD.
On my end, with a terribly slow HDD, indexing my whole database (not really big yet), takes the monstruous time of 10s.
Querying is generally really fast, I can gather all the references to the current file in something like 0.1s.
- Add more query possibilities, currently only support
tantivyqueries, would like to have nested queries
- Add editor supports (Nvim support is WIP)