zk

Looking for a quick usage example? Let's get started.

Description

zk is a command-line tool helping you to maintain a plain text Zettelkasten or personal wiki.

Creating notes from templates
Advanced search and filtering capabilities including tags, links and mentions
Integration with your favorite editors:
- Any LSP-compatible editor
- zk-nvim for Neovim 0.5+
- zk-vscode for Visual Studio Code
- (unmaintained) zk.nvim for Neovim 0.5+ by Seth Messer
Interactive browser, powered by fzf
Git-style command aliases and named filters
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

See the changelog for the list of upcoming features waiting to be released.

A note editor.
A tool to serve your notes on the web – for this, you may be interested in Neuron or Gollum.

Check out the latest release for pre-built binaries for macOS and Linux (zk was not tested on Windows).

brew install mhanberg/zk/zk

Or, if you want to build from the source directly:

brew install --build-from-source mhanberg/zk/zk

You can install the zk package from the official repos.

sudo pacman -S zk

Make sure you have a working Go installation, then clone the repository:

$ git clone https://github.com/mickael-menu/zk.git
$ cd zk

icu4c is required to build zk, which you can install with Homebrew.

$ brew install icu4c
$ make
$ ./zk -h

libicu-dev is required to build zk, use your favorite package manager to install it.

$ apt-install libicu-dev
$ make
$ ./zk -h