zk

README

zk

A plain text note-taking assistant

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.

It is primarily focused on:

• keeping your notebook future-proof, by relying on plain text
• creating notes from templates
• performing advanced search queries
• being a hub for everything related to your notes, thanks to command aliases and automation.
• notebook housekeeping

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.

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

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