mirror of https://github.com/mickael-menu/zk
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.
7c1bd8b318
|
3 years ago | |
|---|---|---|
| adapter | 3 years ago | |
| cmd | 3 years ago | |
| core | 3 years ago | |
| docs | 3 years ago | |
| util | 3 years ago | |
| .gitattributes | 3 years ago | |
| .gitignore | 3 years ago | |
| LICENSE | 3 years ago | |
| README.md | 3 years ago | |
| go | 3 years ago | |
| go.mod | 3 years ago | |
| go.sum | 3 years ago | |
| main.go | 3 years ago | |
| run | 3 years ago | |
README.md
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.
Roadmap
- Tags
- Link relations
- Extended YAML front matter support
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