mirror of
https://github.com/mickael-menu/zk
synced 2024-11-07 15:20:21 +00:00
2.0 KiB
2.0 KiB
Description
zk
is a command-line tool helping you to maintain a plain text Zettelkasten or personal wiki.
Highlights
- Creating notes from templates
- Advanced search and filtering capabilities including tags, links and mentions
- Interactive browser, powered by
fzf
- Git-style command aliases
- Made with automation in mind
- Notebook housekeeping
- Future-proof, thanks to Markdown
- Supports most Markdown syntax flavors
- Links: regular Markdown links,
[[Wikilinks]]
and Neuron's[[Folgezettel links]]#
. - Tags:
#hashtags
,:colon:separated:tags:
, Bear's#multi-word tags#
. - YAML frontmatter
- Links: regular Markdown links,
See the changelog for the list of upcoming features waiting to be released.
What zk
is not
- A note editor.
- A tool to serve your notes on the web – for this, you may be interested in Neuron or Gollum.
Install
zk
was only tested on macOS and Linux.
Build from scratch
Make sure you have a working Go installation, with Go's bin
directory in your PATH
.
$ git clone https://github.com/mickael-menu/zk.git
$ cd zk
$ chmod a+x go
$ ./go install
$ zk -h
Related projects
- Neuron – a great tool to publish a Zettelkasten on the web
- sirupsen's zk – a collection of scripts with a similar purpose