Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Magnushhoie/FuzzyNotes
Blazingly fast search and editing of note files in your terminal. Built with FZF.
https://github.com/Magnushhoie/FuzzyNotes
bash code-snippets grep notes-app quickreference search vim
Last synced: about 1 month ago
JSON representation
Blazingly fast search and editing of note files in your terminal. Built with FZF.
- Host: GitHub
- URL: https://github.com/Magnushhoie/FuzzyNotes
- Owner: Magnushhoie
- License: mit
- Created: 2020-05-16T23:37:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-23T23:39:45.000Z (about 2 years ago)
- Last Synced: 2024-05-21T11:25:24.828Z (7 months ago)
- Topics: bash, code-snippets, grep, notes-app, quickreference, search, vim
- Language: Shell
- Homepage:
- Size: 584 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-blazingly-fast - bash_ref - Blazingly fast search and editing of note files in your terminal. Built with FZF. (Shell)
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
FuzzyNotes (outdated, please see
Fuz)
Ultra-fast, terminal based note searching and editing app powered by FZF and vim. Click to watch tutorial:
### What is FuzzyNotes?
FuzzyNotes 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.
FuzzyNotes 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.
## Usage
- fz: Interactively and recursively searches across all text files in ~/_FuzzyNotes/ directory. Opens file with less for easy copy-paste or scrolling
- fze: Lists all files with search match and previews matched text. Opens file in editor.
See [notes.txt](_FuzzyNotes/notes.txt) for example note file.
Typical 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.
### Features:
- Interactive search with FZF, partial search matches
- Preview matches in side-bar
- Code highlighting
- fze always opens file at last edited location
- Assumes first keyword is either a file, or keywords (e.g. fz python hello world will either search python.txt or across all files)
## Installation
Sets up notes directory and adds aliases to ~/.bash_profile or ~/.zshrc.
```bash
# Requirements
brew install fzf
brew install bat
# Install
git clone https://github.com/Magnushhoie/FuzzyNotes/
cd FuzzyNotes
bash setup.sh
```
## Documentation
Use "**fz --help**" for all arguments.
#### fz - "Fuzzy" search and view
```bash
usage: fz [file] keywords
keywords: Search terms, space-separated
file: Optional, filename (without extension) in note folder
Example usage:
# Interactively search / preview / open files for selected lines starting with __ or #:
fz
# Search across all files for "list"
fz list
# Search across all lines (not just starting with __ or #)
fz -f
# Search python.py in note folder for "list" "comprehension"
fz python list comprehension
```
#### fze - "Fuzzy" edit
```bash
usage: fze [file] keywords
keywords: Search terms, space-separated
file: Optional, filename (without extension) in note folder
Example usage:
# Interactively select file in _FuzzyNotes
fze
# Open last modified file at last edited location by pressing Enter twice
fze
# Search file python.py (no extension) for keywords "for" and "loop". Opens match in vim.
fze python for loop
# Open _FuzzyNotes folder
fze --open
# Open file in system editor
fze --open notes.txt
# Add new file, named new_note.txt
fze -n new_note.txt
```
## Testing
```bash
bash test/test.sh
```
## Compatibility
Compatible with zsh. Tested on MacOS Mojave/Big Sur and Ubuntu 21.04.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)
[contributors-shield]: https://img.shields.io/github/contributors/Magnushhoie/FuzzyNotes.svg?style=for-the-badge
[contributors-url]: https://github.com/Magnushhoie/FuzzyNotes/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Magnushhoie/FuzzyNotes.svg?style=for-the-badge
[forks-url]: https://github.com/Magnushhoie/FuzzyNotes/network/members
[stars-shield]: https://img.shields.io/github/stars/Magnushhoie/FuzzyNotes.svg?style=for-the-badge
[stars-url]: https://github.com/Magnushhoie/FuzzyNotes/stargazers
[issues-shield]: https://img.shields.io/github/issues/Magnushhoie/FuzzyNotes.svg?style=for-the-badge
[issues-url]: https://github.com/Magnushhoie/FuzzyNotes/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/Magnushhoie/FuzzyNotes/blob/master/LICENSE.txt