{"id":14156572,"url":"https://github.com/terror/zk","last_synced_at":"2025-03-15T11:32:58.796Z","repository":{"id":37991213,"uuid":"340818265","full_name":"terror/zk","owner":"terror","description":"A note-taking tool based on the famous Zettelkasten method","archived":false,"fork":false,"pushed_at":"2022-06-12T18:57:53.000Z","size":385,"stargazers_count":87,"open_issues_count":11,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-14T22:03:20.651Z","etag":null,"topics":["fuzzy-search","note-taking","rust","terminal-based","zettelkasten"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/terror.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-21T04:39:08.000Z","updated_at":"2025-03-02T12:52:05.000Z","dependencies_parsed_at":"2022-08-31T11:14:37.695Z","dependency_job_id":null,"html_url":"https://github.com/terror/zk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terror%2Fzk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terror%2Fzk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terror%2Fzk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terror%2Fzk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/terror","download_url":"https://codeload.github.com/terror/zk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243652701,"owners_count":20325610,"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":["fuzzy-search","note-taking","rust","terminal-based","zettelkasten"],"created_at":"2024-08-17T08:06:35.967Z","updated_at":"2025-03-15T11:32:58.436Z","avatar_url":"https://github.com/terror.png","language":"Rust","funding_links":[],"categories":["rust"],"sub_categories":[],"readme":"## zk\n\n\u003cimg align=\"right\" width=\"225\" height=\"120\" src=\"./assets/zk.png\"\u003e\n\n[![Build](https://github.com/terror/zk/actions/workflows/build.yaml/badge.svg?branch=master)](https://github.com/terror/zk/actions/workflows/build.yaml)\n[![crates.io](https://shields.io/crates/v/zkt.svg)](https://crates.io/crates/zkt)\n\nA note-taking tool based on the famous *Zettelkasten* method with support for\nfuzzy searching, tags \u0026 link exploration, in Rust!\n\n### What is a *Zettelkasten*?\n\nA **zettelkasten**, or 'slip box' is a method of note-taking famously used by\nthe sociologist Niklas Luhmann. Notes essentially contain metadata such as tags\nthat describe key aspects of the note or links to other notes. The goal is to\nenhance creativity by exploring the relationships between notes and\nmaking new connections between seemingly unrelated ideas.\n\n### Features\n- Fast fuzzy search and link exploration powered by [skim](https://github.com/lotabout/skim)\n- Works with a flat directory of markdown files\n- Minimal configuration with sensible defaults\n\n### Demo\n\nHere is a quick demo showcasing the new, search, tag, link and explore\nfeatures.\n\n[![asciicast](https://asciinema.org/a/4TrHLpcAv9lk0RfGngzS6ft3e.svg)](https://asciinema.org/a/4TrHLpcAv9lk0RfGngzS6ft3e)\n\n### Installation\n\nYou can install `zk` using cargo (note the `zkt` crate name):\n```bash\n$ cargo install zkt\n```\n\n### Usage\n\n```\nzk 0.0.3\n\nUSAGE:\n    zk \u003cSUBCOMMAND\u003e\n\nFLAGS:\n    -h, --help       Prints help information\n    -V, --version    Prints version information\n\nSUBCOMMANDS:\n    dir                    Output the Zettelkasten directory path\n    explore \u003cname\u003e         Explore a notes links recursively\n    find    \u003ctag\u003e          Find notes by tag\n    link    \u003cleft\u003e \u003cright\u003e Link two notes\n    new     \u003cname\u003e         Create a new note\n    open    \u003cname\u003e         Open a note\n    rm      \u003cname\u003e         Remove a note\n    rmlink  \u003cleft\u003e \u003cright\u003e Remove a link between two notes\n    rmtag   \u003cname\u003e \u003ctag\u003e   Remove a tag from a note\n    search                 Fuzzy search notes\n    tag     \u003cname\u003e \u003ctag\u003e   Add a tag to a note\n    help                   Prints this message or the help of the given subcommand(s)\n```\n\n### Configuration\n\n`zk` currently looks for a configuration file called `.zk.toml` using the\n[rust-xdg](https://github.com/whitequark/rust-xdg) crate.\n\nIf a configuration file is found it must have the following key-value pairs\nset (default values are shown below if no configuration file is present):\n\n```toml\n# .zk.toml\n\n# The Zettelkasten directory path.\npath = '~/.zk'\n\n# The preferred editor of choice when opening\n# and editing notes.\neditor = 'vim'\n```\n\n### Keybindings\n\nThe fuzzy finder `skim` supports the implementation of custom keybindings, this\nsection documents the custom keybindings that are implemented when using\nvarious commands.\n\n| Command | Keybindings                                                                      |\n|---------|----------------------------------------------------------------------------------|\n| explore | `\u003cC-e\u003e` - Edit the selected note\u003cbr/\u003e `Enter` - Explore the selected notes links |\n\n### Related work\n[`srid/neuron`](https://github.com/srid/neuron) - Future-proof note-taking and publishing based on Zettelkasten\n\n[`AndrewCopeland/zettelkasten`](https://github.com/AndrewCopeland/zettelkasten) - Creating notes with the zettelkasten note taking method and storing all notes on github\n\n[`sirupsen/zk`](https://github.com/sirupsen/zk) - Zettelkasten on the command-line 📚 🔍\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterror%2Fzk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterror%2Fzk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterror%2Fzk/lists"}