frank/notes-bash
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A simple note taking tui bash script powered by fzf
52 commits 1 branch 0 tags 83 KiB
  • Shell 100%
Find a file
Exact
JianZcar 840664e484
 Renamed var REVERSE to REVERSE_LIST
2025-01-19 20:36:38 +08:00
bin Renamed var REVERSE to REVERSE_LIST 2025-01-19 20:36:38 +08:00
LICENSE Create LICENSE 2025-01-18 20:33:08 +08:00
README.md Update README.md 2025-01-19 19:27:40 +08:00

README.md

Notes

A note management bash script. Powered by junegunn/fzf

Sample Image Sample Image Sample Image Sample Image

Features

  • New: Create a new note with the current date and time as the filename.
  • Open: Open an existing note.
  • Search: Search within notes for specific content.
  • Delete: Delete selected notes.

Planned Features

  • Tags: tagging system
  • Version control: utilize git for syncing notes
  • Make an installer: use brew for packaging
  • CLI: create a cli that allows piping, etc.

Goals

  • Provide a straightforward and minimalistic note management solution using a Bash script.
  • Ensure ease of use with intuitive commands and interface.

Requirements

  • Bash
  • fzf (fuzzy finder)
  • bat (for enhanced preview)
  • Your preferred text editor (default is nano)

Usage

  1. Clone the repository:
git clone https://github.com/JianZcar/notes-bash.git
cd notes-bash
  1. Make the script executable:
chmod +x bin/notes
  1. Run the script:
./bin/notes

Configuration

  • Default Directory: Change the default directory for notes by modifying the NOTES_DIR variable in the script.
  • Text Editor: Change the text editor by modifying the EDITOR variable in the script.
  • Text Format: Change the text format by modifying the TEXT_FORMAT variable in the script.

Contributing

Feel free to fork the repository and submit pull requests. Contributions are welcome!

License

This project is licensed under the terms of the GNU General Public License v3.0. For more details, see the LICENSE file in the repository.