# Install zk with Homebrew

Plain text note-taking assistant. Version 0.15.6 via Homebrew; verified 2026-07-26.

## Install

```sh
sudo av install brew:zk
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install zk
```

  Evidence: provider-native install command

## Package facts

- **Package key:** brew:zk
- **Package manager:** Homebrew
- **Version:** 0.15.6
- **Source summary:** Plain text note-taking assistant
- **Homepage:** <https://zk-org.github.io/zk/>
- **Repository:** <https://github.com/zk-org/zk>
- **Last updated:** 2026-07-26T15:44:13Z
- **Generated:** 2026-08-03T00:40:33+00:00

## Executables

- zk (alias)

## Install behavior

- Bottle: not available

## Freshness

- Page generated: 2026-08-03
- Package-manager version: 0.15.6
## Project history and usage

zk is a command-line note-taking assistant for plain-text Zettelkasten and personal-wiki workflows. It is aimed at people who want Markdown files, editor integration, fast search, and links without adopting a heavyweight notes application.

### Project history

The README describes zk as a CLI that helps maintain a plain-text Zettelkasten or personal wiki. Its design centers on a notebook directory, Markdown notes, links, tags, templates, search, and editor workflows rather than a standalone GUI.

The project later moved from solo maintenance into the `zk-org` organization. The v0.14.1 release notes describe that release as the first after the project transferred from Mickael Menu's solo hands to zk-org, with new maintainers contributing behind-the-scenes fixes and maintenance.

The broader zk ecosystem includes a Language Server Protocol surface plus editor clients. The official docs describe LSP features such as Markdown link completion, tag completion, hover previews, navigation, diagnostics for dead links, and custom commands; companion projects include zk-nvim and zk-vscode.

### Adoption history

zk found its niche among terminal and editor users who liked the Zettelkasten idea but wanted files and command-line composition instead of a closed notes app. The official docs advertise installation through common Unix-oriented channels and present the tool as leveraging the power of the command line.

The 2024 maintainer discussion and transfer to zk-org show an adoption pattern common to useful niche CLIs: users depended on the tool enough that community members organized around maintenance when the original solo-maintainer model was no longer enough.

### How it is used

Users keep notes in a notebook directory, configure behavior in `.zk/config.toml`, and use commands to create, edit, search, filter, tag, and link Markdown notes. The notes documentation lists workflows for notebook anatomy, creating notes, full-text or exact search, regular expressions, tag filtering, date filtering, and link exploration.

Editor integration is central to practical use. zk ships an LSP server, and users can connect it to Neovim, Vim, Helix, Sublime Text, Visual Studio Code, and other LSP-compatible editors so the CLI becomes an indexer and note graph backend for the editor they already use.

### Why package nerds care

zk is package-nerd significant because it is the note-taking equivalent of a good Unix filter: it leaves the important artifact as plain Markdown while adding indexing, search, linking, templates, and editor protocol support around it.

It also demonstrates a modern CLI pattern where the package is both an executable and a language server. Installing it gives shell commands plus editor intelligence, without pulling in a GUI application or a hosted sync service.

### Timeline

- 2021: zk's public repository history begins before the later zk-org transfer.
- 2024: Maintainers discuss the project's future and the move into the zk-org organization.
- 2024: v0.14.1 is released as the first release after the transfer from solo maintenance to zk-org.
- 2026: The project continues with releases in the v0.15 series and companion editor integrations.

### Related projects

- zk-nvim, the Neovim extension for zk.
- zk-vscode, the Visual Studio Code client for zk's language server.
- zk-emacs, editor integrations using the same notebook-oriented model.
- Other plain-text note and Zettelkasten tools such as Obsidian, Zettlr, nb, Vimwiki, and Zim.

### Sources

- <https://github.com/zk-org/zk>
- <https://github.com/zk-org/zk-nvim>
- <https://github.com/zk-org/zk-vscode>
- <https://github.com/zk-org/zk/discussions/371>
- <https://github.com/zk-org/zk/releases>
- <https://zk-org.github.io/zk>
- <https://zk-org.github.io/zk/notes/index.html>
- <https://zk-org.github.io/zk/tips/editors-integration.html>


## Security Notes

narrow executable package without higher-risk signals.

- **Geiger risk:** green / low
- narrow executable package without higher-risk signals


## Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.


## Configuration files

- Unix: .zk/config.toml

## Combined YAML source

View the package source record on GitHub. [combined/zk.yml](https://github.com/automic-vault/db/blob/main/combined/zk.yml)


## Sources

- Nucleus package database
- Geiger risk classifier
- curated configuration and credential file locations
- curated package history
- pkgdb category and tag curation