You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

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

zk was only tested on macOS and Linux.

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