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). Join us on Matrix for general, support and development discussion: [\#zk-org:pub.solar](https://matrix.to/#/#zk-org:pub.solar). ### Highlights - [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-emacs`](https://codeberg.org/mcookly/zk-emacs) for Emacs - [`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 and `[[Wikilinks]]`. - 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, there are some [static site solutions](docs/tips/static-sites.md). ## Install [Check out the latest release](https://github.com/zk-org/zk/releases) for pre-built binaries for macOS, Linux and Windows. > [!WARNING] The pre-built binaries are not code-signed. In the past Windows > Defender and other security tools have flagged some versions of the Windows > binary as malicious. Building `zk` yourself is currently the recommended > workaround on Windows — see [Build from scratch](#build-from-scratch). See > [#740](https://github.com/zk-org/zk/issues/740) for details. ### Homebrew ```sh brew install zk ``` Or, if you want the latest state of main: ```sh brew install --HEAD zk ``` ### Nix `zk` is available in nixpkgs and has a [Home Manager](https://github.com/nix-community/home-manager) module. If you want to run `zk` without permanently installing it: ``` nix run nixpkgs#zk ``` Or, if you want to create an ephemeral shell with `zk` available: ``` nix shell nixpkgs#zk ``` To permanently install `zk` on NixOS at the system level, include `nixpkgs.zk` in `environment.systemPackages` in your system configuration (`/etc/nixos/configuration.nix` by default): ``` environment.systemPackages = [ # Your other packages here nixpkgs.zk ]; ``` If you are using [Home Manager](https://github.com/nix-community/home-manager), instead of installing for all users on the system, you can permanently install and configure `zk` just for your user via the Home Manager module. Add this to your Home Manager configuration: ``` programs.zk.enable = true; # Modify `${XDG_CONFIG_HOME}/zk/config.toml` through this attr programs.zk.settings = { # Add your own configuration settings for zk here }; ``` ### 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 ``` ### MacPorts ```sh sudo port install 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 make build ``` The latest state of main can be considered the stable _pre-release_ state. To use the absolute latest state (bugs to be expected) and to contribute: ``` git checkout dev make build ``` #### On macOS / Linux ``` $ make $ ./zk -h ``` ## Contributing We warmly welcome issues, PRs and [discussions](https://github.com/zk-org/zk/discussions). _Be sure when contributing to branch from dev, not main._ 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 (see [Emanote configuration for zk](https://emanote.srid.ca/zk)) - [Weave](https://github.com/matze/weave) – another tool to publish Zettelkasten on the web - [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 - [zk-graph-view](https://github.com/cyberSapoPerro/zk-graph-view) - interactive graph visualization plugin for zk