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.
b82f1f547c
|
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 | |
| CHANGELOG.md | 3 years ago | |
| LICENSE | 4 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 | |
README.md
Description
zk is a command-line tool helping you to maintain a plain text Zettelkasten or personal wiki.
Highlights
- Creating notes from templates
- Advanced search and filtering capabilities including tags, links and mentions
- Interactive browser, powered by
fzf - Git-style command aliases
- Made with automation in mind
- Notebook housekeeping
- Future-proof, thanks to Markdown
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
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
Related projects
- Neuron – a great tool to publish a Zettelkasten on the web
- sirupsen's zk – a collection of scripts with a similar purpose