You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Mickaël Menu c21c4fc21f
LSP: Add support for external URLs with `documentLink` (#261)
5 days ago
.github Bump actions/stale from 5 to 6 (#258) 1 week ago
docs neuron.md: Add link to docs for Emanote (#247) 4 weeks ago
internal LSP: Add support for external URLs with `documentLink` (#261) 5 days ago
tests Fix error when pairing `--link-to` and `--linked-by` (#255) 2 weeks ago
.gitignore Fix Windows build (#171) 7 months ago
CHANGELOG.md LSP: Add support for external URLs with `documentLink` (#261) 5 days ago
LICENSE Initial commit 2 years ago
Makefile Release zk 0.11.1 3 months ago
README.md neuron.md: Add link to docs for Emanote (#247) 4 weeks ago
go.mod Upgrade to Go 1.18 and update dependencies (#221) 4 months ago
go.sum Upgrade to Go 1.18 and update dependencies (#221) 4 months ago
main.go Hide index progress in non-interactive shells (#234) 3 months ago

README.md

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
  • 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