{"id":13514658,"url":"https://github.com/Magnushhoie/FuzzyNotes","last_synced_at":"2025-03-31T03:31:09.497Z","repository":{"id":147119528,"uuid":"264547922","full_name":"Magnushhoie/FuzzyNotes","owner":"Magnushhoie","description":"Blazingly fast search and editing of note files in your terminal. Built with FZF.","archived":false,"fork":false,"pushed_at":"2022-11-23T23:39:45.000Z","size":598,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-05-21T11:25:24.828Z","etag":null,"topics":["bash","code-snippets","grep","notes-app","quickreference","search","vim"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Magnushhoie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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}},"created_at":"2020-05-16T23:37:31.000Z","updated_at":"2024-08-01T06:06:48.707Z","dependencies_parsed_at":"2023-07-11T13:35:23.017Z","dependency_job_id":null,"html_url":"https://github.com/Magnushhoie/FuzzyNotes","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/Magnushhoie%2FFuzzyNotes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Magnushhoie%2FFuzzyNotes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Magnushhoie%2FFuzzyNotes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Magnushhoie%2FFuzzyNotes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Magnushhoie","download_url":"https://codeload.github.com/Magnushhoie/FuzzyNotes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246413377,"owners_count":20773053,"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":["bash","code-snippets","grep","notes-app","quickreference","search","vim"],"created_at":"2024-08-01T05:00:59.813Z","updated_at":"2025-03-31T03:31:08.170Z","avatar_url":"https://github.com/Magnushhoie.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"\u003c!-- PROJECT SHIELDS --\u003e\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Magnushhoie/FuzzyNotes\"\u003e\n  \u003c/a\u003e\n\n  \u003ch1 align=\"center\"\u003eFuzzyNotes (outdated, please see\n  \u003ca href=\"https://github.com/Magnushhoie/fuz\"\u003eFuz\u003c/a\u003e)\u003c/h1\u003e\n\n  \u003cp align=\"center\"\u003e\n    Ultra-fast, \u003ca href=\"\"\u003eterminal based\u003c/a\u003e note searching and editing app powered by \u003ca href=\"https://github.com/junegunn/fzf\"\u003eFZF\u003c/a\u003e and \u003ca href=\"https://danielmiessler.com/study/vim/\"\u003evim.\u003c/a\u003e Click to watch tutorial:\n\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"img/image.jpg\" alt=\"Logo\" width=\"700\"\u003e\n\u003c/p\u003e\n\n\n\n### What is FuzzyNotes?\n\nFuzzyNotes interactively searches and returns text search results from a nested folder of text files. Files are previewed or opened at exact match for copying or editing.\nFuzzyNotes solves the problem of being unable to access text you forgot where you wrote. With FuzzyNotes, any written text will always be found, assuming its there.\n\n## Usage\n- fz: Interactively and recursively searches across all text files in ~/_FuzzyNotes/ directory. Opens file with less for easy copy-paste or scrolling\n- fze: Lists all files with search match and previews matched text. Opens file in editor.\n\nSee [notes.txt](_FuzzyNotes/notes.txt) for example note file.\n\nTypical use-cases are for project notes or log-books, code-snippets, or on top of knowledge management software like Obsidian or Roam. FuzzyNotes works with any nested collection of text files.\n\n\n### Features:\n- Interactive search with FZF, partial search matches\n- Preview matches in side-bar\n- Code highlighting\n- fze always opens file at last edited location\n- Assumes first keyword is either a file, or keywords (e.g. fz python hello world will either search python.txt or across all files)\n\n## Installation\n\nSets up notes directory and adds aliases to ~/.bash_profile or ~/.zshrc.\n\n```bash\n# Requirements\nbrew install fzf\nbrew install bat\n\n# Install\ngit clone https://github.com/Magnushhoie/FuzzyNotes/\ncd FuzzyNotes\nbash setup.sh\n```\n\n\n## Documentation\n\nUse \"**fz --help**\" for all arguments.\n\n#### fz - \"Fuzzy\" search and view\n\n```bash\nusage: fz [file] keywords\n  keywords: Search terms, space-separated\n  file: Optional, filename (without extension) in note folder\n\nExample usage:\n# Interactively search / preview / open files for selected lines starting with __ or #:\nfz\n\n# Search across all files for \"list\"\nfz list\n  \n# Search across all lines (not just starting with __ or #)\nfz -f\n\n# Search python.py in note folder for \"list\" \"comprehension\"\nfz python list comprehension\n```\n\n#### fze - \"Fuzzy\" edit\n\n```bash\nusage: fze [file] keywords\n  keywords: Search terms, space-separated\n  file: Optional, filename (without extension) in note folder\n\nExample usage:\n# Interactively select file in _FuzzyNotes\nfze\n\n# Open last modified file at last edited location by pressing Enter twice\nfze \u003center\u003e \u003center\u003e\n\n# Search file python.py (no extension) for keywords \"for\" and \"loop\". Opens match in vim.\nfze python for loop\n  \n# Open _FuzzyNotes folder\nfze --open\n  \n# Open file in system editor\nfze --open notes.txt\n\n# Add new file, named new_note.txt\nfze -n new_note.txt\n```\n\n## Testing\n\n```bash\nbash test/test.sh\n```\n\n## Compatibility\nCompatible with zsh. Tested on MacOS Mojave/Big Sur and Ubuntu 21.04.\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n[MIT](https://choosealicense.com/licenses/mit/)\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/Magnushhoie/FuzzyNotes.svg?style=for-the-badge\n[contributors-url]: https://github.com/Magnushhoie/FuzzyNotes/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/Magnushhoie/FuzzyNotes.svg?style=for-the-badge\n[forks-url]: https://github.com/Magnushhoie/FuzzyNotes/network/members\n[stars-shield]: https://img.shields.io/github/stars/Magnushhoie/FuzzyNotes.svg?style=for-the-badge\n[stars-url]: https://github.com/Magnushhoie/FuzzyNotes/stargazers\n[issues-shield]: https://img.shields.io/github/issues/Magnushhoie/FuzzyNotes.svg?style=for-the-badge\n[issues-url]: https://github.com/Magnushhoie/FuzzyNotes/issues\n[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge\n[license-url]: https://github.com/Magnushhoie/FuzzyNotes/blob/master/LICENSE.txt\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMagnushhoie%2FFuzzyNotes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMagnushhoie%2FFuzzyNotes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMagnushhoie%2FFuzzyNotes/lists"}