leokhoa/NoteSH

NoteSH fully functional sticky notes App in your Terminal!

📝 NoteSH

Fully functional sticky notes App in your Terminal! Built with Textual, an amazing TUI framework!

Installation

Best option to install is using pipx:

pipx install notesh
# but it is still possible to do it with just pip:
pip install notesh

Usage

To start using just type in your terminal:

notesh

it will create new file notes.json in current directory. You can also specify file by using -f flag:

notesh -f MyNotes.json
# or full/relative path
notesh -f ~/Documents/MyNotes.json

➕ Create new Note

• To create new note just press Ctrl+A
• You can change color with buttons but also using scroll
• To edit note just click in its body

🧅 It supports layers

• To move note grab it top part and move with mouse

🗚 You can resize notes

• To resize grab left bottom corner and move with mouse

💡 And background is resizable

• If you make make background to big it will readjust after you reopen App
• You can also click CTRL-Mouse to look around whole wall

NEW FEATURES

💡 Highlight when mouse is over

➕ New Drawable that support borders change

TODO

There are many thigs to add! If you have idea, please create Issue with your suggestions.

• Safe saving (now if there are any bugs you may lost your notes)
• Vim Key bindings
• Duplicate Note
• Hiding menu (Color Picker etc.)
• TOML config file
• Left Sidebar (for background and preferences)
• Align tool for text
• Fixed layers (if needed)
• Diffrent Drawables:
  • Check List
  • Arrows

and also resolve problems:

• Multiline Input (currently textual does not support it and here we have my hacky solution)

Thanks

Big thanks to Will McGugan and all members and contributors of Textualize.io! Go checkout Textual amazing TUI framework on which this app is based.