mickael-menu / zk

A plain text note-taking assistant

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

Nix

# Run zk from Nix store without installing it:
nix run nixpkgs#zk
# Or, to install it permanently:
nix-env -iA 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 1.18+ installation, then clone the repository:

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

On macOS

$ make
$ ./zk -h

On Linux

$ make
$ ./zk -h

Related projects

  • Neuron – a great tool to publish a Zettelkasten on the web
  • Emanote – an improved successor to Neuron
  • sirupsen's zk – a collection of scripts with a similar purpose
  • zk-spaced – spaced repetition plugin for zk

About

A plain text note-taking assistant

License:GNU General Public License v3.0


Languages

Language:Go 99.6%Language:Makefile 0.4%