{"id":13467652,"url":"https://github.com/zk-org/zk","last_synced_at":"2025-05-13T22:09:23.243Z","repository":{"id":38615142,"uuid":"323932509","full_name":"zk-org/zk","owner":"zk-org","description":"A plain text note-taking assistant","archived":false,"fork":false,"pushed_at":"2025-04-28T08:08:25.000Z","size":1451,"stargazers_count":2031,"open_issues_count":14,"forks_count":155,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-04-29T13:40:28.363Z","etag":null,"topics":["cli","notes","second-brain","wiki","zettelkasten"],"latest_commit_sha":null,"homepage":"https://zk-org.github.io/zk/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zk-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-12-23T15:07:51.000Z","updated_at":"2025-04-29T12:24:13.000Z","dependencies_parsed_at":"2023-02-10T16:01:03.668Z","dependency_job_id":"5c8b3bff-dae5-40d0-8e88-e01a0f5c50f8","html_url":"https://github.com/zk-org/zk","commit_stats":{"total_commits":326,"total_committers":36,"mean_commits":9.055555555555555,"dds":0.1901840490797546,"last_synced_commit":"c3f26ca12b8f35cbc09868d89937951c636c7a0a"},"previous_names":["zk-org/zk","mickael-menu/zk"],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zk-org%2Fzk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zk-org%2Fzk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zk-org%2Fzk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zk-org%2Fzk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zk-org","download_url":"https://codeload.github.com/zk-org/zk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254036830,"owners_count":22003654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","notes","second-brain","wiki","zettelkasten"],"created_at":"2024-07-31T15:00:58.926Z","updated_at":"2025-05-13T22:09:18.234Z","avatar_url":"https://github.com/zk-org.png","language":"Go","funding_links":[],"categories":["Go","Notes","cli","Uncategorized"],"sub_categories":["Uncategorized"],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cimg alt=\"zk logo\" width=\"20%\" src=\"./docs/assets/media/zk-black-modern.png\" /\u003e\n\u003ch4\u003eA plain text note-taking assistant\u003c/h4\u003e\n\u003cimg alt=\"Screencast\" width=\"95%\" src=\"docs/assets/media/screencast.svg\"/\u003e\n\u003c/div\u003e\n\n## Description\n\n`zk` is a command-line tool helping you to maintain a plain text\n[Zettelkasten](https://zettelkasten.de/introduction/) or\n[personal wiki](https://en.wikipedia.org/wiki/Personal_wiki).\n\nLooking for a\n[quick usage example?](https://zk-org.github.io/zk/tips/getting-started.html)\n\nOr want to see it in action? Checkout [Shivan's](https://github.com/shivan-s)\nvideo,\n[_Note-taking System ALL Programmers Should Consider_](https://www.youtube.com/watch?v=UzhZb7e4l4Y).\n\n### Highlights\n\n\u003e Note: Links in the below list are outbound ↗\n\n- [Creating notes from templates](https://zk-org.github.io/zk/notes/note-creation.html)\n- [Advanced search and filtering capabilities](https://zk-org.github.io/zk/notes/note-filtering.html)\n  including [tags](https://zk-org.github.io/zk/notes/tags.html), links and\n  mentions\n- [Integration with your favorite editors](https://zk-org.github.io/zk/tips/editors-integration.html):\n  - [Any LSP-compatible editor](https://zk-org.github.io/zk/tips/editors-integration.html)\n  - [`zk-nvim`](https://github.com/zk-org/zk-nvim) for Neovim 0.8+\n  - [`zk-vscode`](https://github.com/zk-org/zk-vscode) for Visual Studio Code\n- [Interactive browser](https://zk-org.github.io/zk/config/tool-fzf.html),\n  powered by `fzf`\n- [Git-style command aliases](https://zk-org.github.io/zk/config/config-alias.html)\n  and [named filters](https://zk-org.github.io/zk/config/config-filter.html)\n- [Made with automation in mind](https://zk-org.github.io/zk/tips/automation.html)\n- [Notebook housekeeping](https://zk-org.github.io/zk/tips/notebook-housekeeping.html)\n- [Future-proof, thanks to Markdown](https://zk-org.github.io/zk/tips/future-proof.html)\n- Supports most Markdown syntax flavors\n  - Links: regular Markdown links and `[[Wikilinks]]`.\n  - Tags: `#hashtags`, `:colon:separated:tags:`, Bear's `#multi-word tags#`.\n  - [YAML frontmatter](https://zk-org.github.io/zk/notes/note-frontmatter.html)\n\n[See the changelog](CHANGELOG.md) for the list of upcoming features waiting to\nbe released.\n\n### What `zk` is not\n\n- A note editor.\n- A tool to serve your notes on the web – for this, there are some [static site solutions](docs/tips/static-sites.md).\n\n## Install\n\n[Check out the latest release](https://github.com/zk-org/zk/releases) for\npre-built binaries for macOS and Linux (`zk` was not tested on Windows).\n\n### Homebrew\n\n```sh\nbrew install zk\n```\n\nOr, if you want to the latest changes:\n\n```sh\nbrew install --HEAD zk\n```\n\n### Nix\n\n`zk` is available in nixpkgs and has a [Home Manager](https://github.com/nix-community/home-manager) module.\n\nIf you want to run `zk` without permanently installing it:\n```\nnix run nixpkgs#zk\n```\n\nOr, if you want to create an ephemeral shell with `zk` available:\n```\nnix shell nixpkgs#zk\n```\n\nTo 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):\n```\nenvironment.systemPackages = [\n  # Your other packages here\n  nixpkgs.zk\n];\n\n```\n\nIf 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:\n```\nprograms.zk.enable = true;\n\n# Modify `${XDG_CONFIG_HOME}/zk/config.toml` through this attr\nprograms.zk.settings = {\n  # Add your own configuration settings for zk here\n};\n```\n\n### Alpine Linux\n\n`zk` is currently available in the `testing` repositories:\n\n```sh\napk add zk\n```\n\n### Arch Linux\n\nYou can install\n[the zk package](https://archlinux.org/packages/extra/x86_64/zk/) from the\nofficial repos.\n\n```sh\nsudo pacman -S zk\n```\n\n### Build from scratch\n\nMake sure you have a working [Go 1.21+ installation](https://golang.org/), then\nclone the repository:\n\n```sh\n$ git clone https://github.com/zk-org/zk.git\n$ cd zk\n```\n\n#### On macOS / Linux\n\n```\n$ make\n$ ./zk -h\n```\n\n## Contributing\n\nWe warmly welcome issues, PRs and\n[discussions](https://github.com/zk-org/zk/discussions).\n\nHere you can read\n[some useful info for contributing to `zk`](./CONTRIBUTING.md).\n\n## Related projects\n\n- [Neuron](https://github.com/srid/neuron) – a great tool to publish a\n  Zettelkasten on the web\n- [Emanote](https://emanote.srid.ca/) – an improved successor to Neuron\n- [sirupsen's zk](https://github.com/sirupsen/zk) – a collection of scripts with\n  a similar purpose\n- [zk-spaced](https://github.com/matze/zk-spaced) – spaced repetition plugin for\n  zk\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzk-org%2Fzk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzk-org%2Fzk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzk-org%2Fzk/lists"}