Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zk-org/zk
A plain text note-taking assistant
https://github.com/zk-org/zk
cli notes second-brain wiki zettelkasten
Last synced: 25 days ago
JSON representation
A plain text note-taking assistant
- Host: GitHub
- URL: https://github.com/zk-org/zk
- Owner: zk-org
- License: gpl-3.0
- Created: 2020-12-23T15:07:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-07T23:30:37.000Z (7 months ago)
- Last Synced: 2024-04-08T18:17:42.063Z (7 months ago)
- Topics: cli, notes, second-brain, wiki, zettelkasten
- Language: Go
- Homepage: https://zk-org.github.io/zk/
- Size: 1.27 MB
- Stars: 1,354
- Watchers: 11
- Forks: 105
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - zk-org/zk - A plain text note-taking assistant (Go)
- jimsghstars - zk-org/zk - A plain text note-taking assistant (Go)
README
A plain text note-taking assistant
## Description
`zk` is a command-line tool helping you to maintain a plain text
[Zettelkasten](https://zettelkasten.de/introduction/) or
[personal wiki](https://en.wikipedia.org/wiki/Personal_wiki).
Looking for a
[quick usage example?](https://zk-org.github.io/zk/tips/getting-started.html)
Or want to see it in action? Checkout [Shivan's](https://github.com/shivan-s)
video,
[_Note-taking System ALL Programmers Should Consider_](https://www.youtube.com/watch?v=UzhZb7e4l4Y).
### Highlights
> Note: Links in the below list are outbound ↗
- [Creating notes from templates](https://zk-org.github.io/zk/notes/note-creation.html)
- [Advanced search and filtering capabilities](https://zk-org.github.io/zk/notes/note-filtering.html)
including [tags](https://zk-org.github.io/zk/notes/tags.html), links and
mentions
- [Integration with your favorite editors](https://zk-org.github.io/zk/tips/editors-integration.html):
- [Any LSP-compatible editor](https://zk-org.github.io/zk/tips/editors-integration.html)
- [`zk-nvim`](https://github.com/zk-org/zk-nvim) for Neovim 0.8+
- [`zk-vscode`](https://github.com/zk-org/zk-vscode) for Visual Studio Code
- [Interactive browser](https://zk-org.github.io/zk/config/tool-fzf.html),
powered by `fzf`
- [Git-style command aliases](https://zk-org.github.io/zk/config/config-alias.html)
and [named filters](https://zk-org.github.io/zk/config/config-filter.html)
- [Made with automation in mind](https://zk-org.github.io/zk/tips/automation.html)
- [Notebook housekeeping](https://zk-org.github.io/zk/tips/notebook-housekeeping.html)
- [Future-proof, thanks to Markdown](https://zk-org.github.io/zk/tips/future-proof.html)
- 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](https://zk-org.github.io/zk/notes/note-frontmatter.html)
[See the changelog](CHANGELOG.md) 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](docs/tips/neuron.md) or [Gollum](https://github.com/gollum/gollum).
## Install
[Check out the latest release](https://github.com/zk-org/zk/releases) for
pre-built binaries for macOS and Linux (`zk` was not tested on Windows).
### Homebrew
```sh
brew install zk
```
Or, if you want to the latest changes:
```sh
brew install --HEAD zk
```
### Nix
```sh
# Run zk from Nix store without installing it:
nix run nixpkgs#zk
# Or, to install it permanently:
nix-env -iA zk
```
### Alpine Linux
`zk` is currently available in the `testing` repositories:
```sh
apk add zk
```
### Arch Linux
You can install
[the zk package](https://archlinux.org/packages/extra/x86_64/zk/) from the
official repos.
```sh
sudo pacman -S zk
```
### Build from scratch
Make sure you have a working [Go 1.21+ installation](https://golang.org/), then
clone the repository:
```sh
$ git clone https://github.com/zk-org/zk.git
$ cd zk
```
#### On macOS / Linux
```
$ make
$ ./zk -h
```
## Contributing
We warmly welcome issues, PRs and
[discussions](https://github.com/zk-org/zk/discussions).
Here you can read
[some useful info for contributing to `zk`](./CONTRIBUTING.md).
## Related projects
- [Neuron](https://github.com/srid/neuron) – a great tool to publish a
Zettelkasten on the web
- [Emanote](https://emanote.srid.ca/) – an improved successor to Neuron
- [sirupsen's zk](https://github.com/sirupsen/zk) – a collection of scripts with
a similar purpose
- [zk-spaced](https://github.com/matze/zk-spaced) – spaced repetition plugin for
zk