/zk

A plain text note-taking assistant

Primary LanguageGoGNU General Public License v3.0GPL-3.0

zk

A plain text note-taking assistant

Screencast

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.

Highlights

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

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

Homebrew

brew install zk

Or, if you want to the latest changes:

brew install --HEAD zk

Arch Linux

You can install the zk package from the official repos.

sudo pacman -S zk

Build from scratch

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

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

On macOS

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

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

On Linux

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

$ apt-install libicu-dev
$ make
$ ./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