DEV Community: Jian Z'car Esteban

How to use 📔FuzPad!

Jian Z'car Esteban — Sat, 01 Feb 2025 11:09:48 +0000

Introduction

FuzPad is designed to provide a straightforward and minimalistic note management solution using a Bash script. It allows you to create, open, search, and delete notes efficiently. FuzPad also supports version control by automatically committing changes to your notes.

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.
Version control: Automatically commits changes to your notes.

Installation

Using Homebrew

brew install JianZcar/packages/fuzpad

Using curl

Ensure ~/.local/bin is in your PATH:

curl -s https://gist.githubusercontent.com/JianZcar/df050e108b462e469f413f0eec229143/raw | bash

Manual Installation

Clone the repository:

git clone https://github.com/JianZcar/FuzPad.git
cd FuzPad

Make the script executable:

chmod +x bin/fuzpad

Run the script:

./bin/fuzpad

Configuration

You can configure FuzPad by setting environment variables in your ~/.bashrc file or directly modifying the script.

Default Directory

Change the default directory for notes:

export FUZPAD_DIR="$HOME/Documents/.notes"

Text Editor

Change the text editor:

export EDITOR="nano"

Text Format

Change the text format:

export FUZPAD_TEXT_FORMAT="txt"

Date Time Format

Change the date and time format used for note filenames:

export FUZPAD_DATE_TIME_FORMAT="%Y-%m-%d-%H-%M-%S"

BAT Theme

Change the theme used by bat for previewing notes:

export FUZPAD_BAT_THEME="OneHalfLight"

Reverse List

Set to true to reverse the order of the list when opening or deleting notes:

export REVERSE_LIST="false"

Sort Format

Change the sorting format for listing notes (T@ for creation date, Y for modified date):

export SORT_FORMAT="T@"

Preview Size

Change the size of the preview window for fzf:

export PREVIEW_SIZE="70%"

Start Line Search Preview

Set the starting line number for the search preview:

export START_LINE_SEARCH_PREVIEW="5"

End Line Search Preview

Set the ending line number for the search preview:

export END_LINE_SEARCH_PREVIEW="9999"

After adding the necessary variables to your ~/.bashrc file, remember to source it to apply the changes:

source ~/.bashrc

Usage

Creating a New Note

To create a new note, select the "New" option from the menu. The note will be created with the current date and time as the filename.

Opening an Existing Note

To open an existing note, select the "Open" option from the menu. You will be presented with a list of notes to choose from.

Searching Within Notes

To search within notes, select the "Search" option from the menu. Enter your search query, and FuzPad will display the matching results.

Deleting Notes

To delete notes, select the "Delete" option from the menu. You can select multiple notes to delete by pressing the tab key to multi-select.

FAQ

How do I change the default text editor?

You can change the default text editor by setting the EDITOR variable in your ~/.bashrc file:

export EDITOR="nano"

Can I use FuzPad without Git?

Yes, you can use FuzPad without Git. However, version control features that automatically commit changes to your notes will not be available.

Contributing

We welcome contributions from the community! Please refer to the Contributing Guidelines for more details on how to get started.

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.

✨ Top 5 Open-Source Terminal Note-Taking Applications ✨

Jian Z'car Esteban — Thu, 30 Jan 2025 00:57:58 +0000

Taking notes efficiently is crucial for developers and professionals who prefer using terminal-based applications. Here are the top 5 open-source terminal note-taking applications that can help you manage your notes effectively.

1. nb 📒

Description: nb is a powerful terminal-based notebook solution that allows you to organize and manage your notes effortlessly. It supports various features like tagging, searching, and encryption to keep your notes secure and accessible.

Repository: nb

2. jrnl 📝

Description: jrnl is a simple yet effective note-taking tool designed for quick and easy journaling from the command line. It supports plain text, Markdown, and encrypted entries to keep your notes private.

Repository: jrnl

3. Joplin CLI 📑

Description: Joplin CLI is the command-line interface version of the popular Joplin note-taking app. It offers features like synchronization, encryption, and Markdown support to help you manage your notes seamlessly.

Repository: Joplin CLI

4. xournalpp ✍️

Description: xournalpp is a handwriting note-taking software with PDF annotation support. It is perfect for those who prefer taking handwritten notes or annotating documents directly from the terminal.

Repository: xournalpp

5. FuzPad 🗒️

Description: FuzPad is a minimalistic note management solution powered by fzf. It provides a simple and efficient way to manage notes directly from the terminal with the power of fuzzy searching.

Repository: FuzPad

These open-source terminal note-taking applications offer various features to cater to different needs. Whether you prefer plain text, Markdown, or handwritten notes, there's an application for you. Try them out and find the one that best suits your workflow!

FuzPad - A minimalistic note management solution. Powered by fzf

Jian Z'car Esteban — Wed, 22 Jan 2025 16:15:29 +0000

📙FuzPad!

FuzPad is a minimalistic note management solution. Powered by ⚡junegunn/fzf⚡

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.
Version control: Automatically commits changes to your notes.

Planned Features

Tags: tagging system
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

Clone the repository:

git clone https://github.com/JianZcar/notes-bash.git
cd notes-bash

Make the script executable:

chmod +x bin/notes

Run the script:

./bin/notes

Configuration

Default Directory: Change the default directory for notes by modifying the FUZPAD_DIR variable in the script or by setting it in your ~/.bashrc file:

  export FUZPAD_DIR="$HOME/Documents/.notes"

Text Editor: Change the text editor by modifying the EDITOR variable in the script or by setting it in your ~/.bashrc file:

  export EDITOR="nano"

Text Format: Change the text format by modifying the TEXT_FORMAT variable in the script or by setting it in your ~/.bashrc file:

  export FUZPAD_TEXT_FORMAT="txt"

Date Time Format: Change the date and time format used for note filenames by modifying the DATE_TIME_FORMAT variable in the script or by setting it in your ~/.bashrc file:

  export FUZPAD_DATE_TIME_FORMAT="%Y-%m-%d-%H-%M-%S"

BAT Theme: Change the theme used by bat for previewing notes by modifying the BAT_THEME variable in the script or by setting it in your ~/.bashrc file:

  export FUZPAD_BAT_THEME="OneHalfLight"

Reverse List: Set to true to reverse the order of the list when opening or deleting notes by modifying the REVERSE_LIST variable in the script or by setting it in your ~/.bashrc file:

  export FUZPAD_REVERSE_LIST="false"

Sort Format: Change the sorting format for listing notes (T@ for creation date, Y for modified date) by modifying the SORT_FORMAT variable in the script or by setting it in your ~/.bashrc file:

  export FUZPAD_SORT_FORMAT="T@"

Preview Size: Change the size of the preview window for fzf by modifying the PREVIEW_SIZE variable in the script or by setting it in your ~/.bashrc file:

  export FUZPAD_PREVIEW_SIZE="70%"

Start Line Search Preview: Set the starting line number for the search preview by modifying the START_LINE_SEARCH_PREVIEW variable in the script or by setting it in your ~/.bashrc file:

  export FUZPAD_START_LINE_SEARCH_PREVIEW="5"

End Line Search Preview: Set the ending line number for the search preview by modifying the END_LINE_SEARCH_PREVIEW variable in the script or by setting it in your ~/.bashrc file:

  export FUZPAD_END_LINE_SEARCH_PREVIEW="9999"

After adding the necessary variables to your ~/.bashrc file, remember to source it to apply the changes:

source ~/.bashrc

Contributing

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

Effortlessly Manage Your Notes with my Bash Script Featuring FZF Integration!

Jian Z'car Esteban — Sat, 18 Jan 2025 10:55:55 +0000

Notes Bash Script Powered by FZF

Manage your notes effortlessly with this Bash script, powered by the fuzzy finder (fzf).

demo

Features

New: Create a new note with the current date and time as the filename.
Open: Open an existing note using fuzzy finder (fzf).
Search: Search within notes for specific content.
Delete: Delete selected notes.
Quit: Exit the script.

Requirements

Bash
fzf (fuzzy finder)
bat (for enhanced preview in search)
Your preferred text editor (default is hx)

Usage

Clone the repository:

git clone https://github.com/JianZcar/notes-bash.git
cd notes-bash

Make the script executable:
```
chmod +x notes
```
Run the script:
```
./notes
```

Configuration

Default Directory: Change the default directory for notes by modifying the 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!

You can view the repository here.