Skip to content

index.rst

Latest commit

 

History

History
80 lines (46 loc) · 1.37 KB

index.rst

File metadata and controls

80 lines (46 loc) · 1.37 KB
Raw

assets/media/zk-black-modern.png

.. toctree::
   :hidden:
   :titlesonly:

   GitHub <https://github.com/zk-org/zk>
   Neovim Plugin <https://github.com/zk-org/zk-nvim>

   config/index
   notes/index
   tips/index

zk is a plain text note-taking assistant that leverages the power of the command line.

Install as below and then... :doc:`get zettling <tips/getting-started>`!

This site always represents the latest state of the documentation.

Installation

Homebrew:

brew install zk

# Or, if you want to be on the bleeding edge:
brew install --HEAD zk

Nix:

# 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:
apk add zk

Arch Linux:

You can install the zk package from the official repos.

sudo pacman -S zk

Build from scratch:

Make sure you have a working Go 1.21+ installation, then clone the repository:

git clone https://github.com/zk-org/zk.git
cd zk

On macOS / Linux:

make
./zk -h