{"id":13647292,"url":"https://github.com/Cvaniak/NoteSH","last_synced_at":"2025-04-22T02:31:09.069Z","repository":{"id":65660941,"uuid":"596770813","full_name":"Cvaniak/NoteSH","owner":"Cvaniak","description":"NoteSH fully functional sticky notes App in your Terminal! ","archived":false,"fork":false,"pushed_at":"2023-10-03T21:29:08.000Z","size":2659,"stargazers_count":450,"open_issues_count":4,"forks_count":17,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-21T15:21:16.011Z","etag":null,"topics":["colorful","console","diagrams","mouse","note","notepad","python","python3","reactive","terminal","textual","textualize","tui"],"latest_commit_sha":null,"homepage":"","language":"Python","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/Cvaniak.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-02-02T22:20:04.000Z","updated_at":"2025-03-12T07:03:55.000Z","dependencies_parsed_at":"2024-01-07T21:02:31.909Z","dependency_job_id":"47af8819-7097-489d-8bf9-ca2e90a6412d","html_url":"https://github.com/Cvaniak/NoteSH","commit_stats":{"total_commits":13,"total_committers":1,"mean_commits":13.0,"dds":0.0,"last_synced_commit":"a9bd8901fdb44e1d7e82113292ca7b1cfe5b5964"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cvaniak%2FNoteSH","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cvaniak%2FNoteSH/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cvaniak%2FNoteSH/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cvaniak%2FNoteSH/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cvaniak","download_url":"https://codeload.github.com/Cvaniak/NoteSH/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250163616,"owners_count":21385271,"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":["colorful","console","diagrams","mouse","note","notepad","python","python3","reactive","terminal","textual","textualize","tui"],"created_at":"2024-08-02T01:03:28.224Z","updated_at":"2025-04-22T02:31:08.300Z","avatar_url":"https://github.com/Cvaniak.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n  \u003ch1 align=\"center\"\u003e 📝 NoteSH \u003c/h1\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n Fully functional sticky notes App in your Terminal! Built with \u003ca href=\"https://github.com/Textualize/textual\"\u003eTextual\u003c/a\u003e, an amazing TUI framework!\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n \u003ca href=\"https://github.com/Cvaniak/NoteSH\"\u003e\u003cimg alt=\"\" src=\"https://raw.githubusercontent.com/Cvaniak/NoteSH/master/documentation/NoteshApp.png\" width=\"100%\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## In last Update \n\n* [**Hoptex**](https://github.com/Cvaniak/Hoptex) Support (you can focus anything easy now)! \n* User default note file\n\n![Hoptex Usage](https://raw.githubusercontent.com/Cvaniak/NoteSH/master/documentation/HoptexNotesh.gif)\n\n## Installation\n\nBest option to install is using [pipx](https://github.com/pypa/pipx):\n\n```bash\npipx install notesh\n# but it is still possible to do it with just pip:\npip install notesh\n```\n\n## Usage\n\nTo start using just type in your terminal:\n\n```bash\nnotesh\n```\n\nit will create new file notes.json in current directory.\nYou can also specify file by using `-f` flag:\n\n```bash\nnotesh -f MyNotes.json\n# or full/relative path\nnotesh -f ~/Documents/MyNotes.json\n```\n\n## ➕ Create new Note\n\n* To create new note just press `Ctrl+A`\n* You can change color with buttons but also using scroll\n* To edit note just click in its body\n\n![New note](https://raw.githubusercontent.com/Cvaniak/NoteSH/master/documentation/CreateNote.gif)\n\n## 🧅 It supports layers\n\n* To move note grab it top part and move with mouse\n\n![Layers](https://raw.githubusercontent.com/Cvaniak/NoteSH/master/documentation/Layers.gif)\n\n## 🗚  You can resize notes\n\n* To resize grab left bottom corner and move with mouse\n\n![Resize Notes](https://raw.githubusercontent.com/Cvaniak/NoteSH/master/documentation/Resizing.gif)\n\n## 💡 And background is resizable\n\n* If you make make background to big it will readjust after you reopen App\n* You can also click `CTRL-Mouse` to look around whole wall\n\n![Resize Background](https://raw.githubusercontent.com/Cvaniak/NoteSH/master/documentation/DynamicResize.gif)\n\n## 💡 Highlight when mouse is over\n\n![Resize Background](https://raw.githubusercontent.com/Cvaniak/NoteSH/master/documentation/HoverOver.gif)\n\n## ➕ New Drawable that support borders change\n\n![Resize Background](https://raw.githubusercontent.com/Cvaniak/NoteSH/master/documentation/NewDrawable.png)\n\n## ⌨️  Vim/Custom key bindings\n\nYou can now do everything using KEYBOARD!\nThis is first version so if you have any suggestions please write them in existing issue.  \nDefault keybindings are in `default_bindings.toml`\nfile that is in root of installation.  \nYou can also create second file `user_bindings.toml` where you can overwrite defaults.\n\n### What you can do\n\n* Change focus `focus_next/focus_previous` using `ctrl+i,ctrl+j/ctrl+o,ctrl+k`\n* Edit note `edit` using `i`\n* When note is focused you can move it with `j/k/l/h`.\n  Also adding shift moves it more with one click\n* Clicking `unfocus` using `escape` returns from edit mode,\n  and unfocus drawable if not in edit mode.\n* Resize note using `+/-` for vertical and `\u003e/\u003c` for horizontal\n* Bring 'ctrl+f' Forward and `ctrl+b` Backward Note\n\n### Bindings file\n\n\u003cdetails\u003e\n\u003csummary\u003eDefault file\u003c/summary\u003e\n\n```toml\n# These are default, they also are displayed at the footer\n[default]\nquit = [\"ctrl+q,ctrl+c\", \"Quit\"]\ntoggle_sidebar_left = [\"ctrl+e\", \"Sidebar Left\"]\nadd_note = [\"ctrl+a\", \"Create Stick Note\"]\nadd_box = [\"ctrl+x\", \"Create Box\"]\nsave_notes = [\"ctrl+s\", \"Save Notes\"]\nunfocus = [\"escape\", \"Unfocus\"]\n\"app.toggle_dark\" = [\"ctrl+t\", \"Dark/Light\"]\n\n[moving_drawables]\n# Default movement\nleft = \"h\"\nright = \"l\"\nup = \"k\"\ndown = \"j\"\n# You can add number after _ and it will move note that many times\nleft_5 = \"H\"\nright_5 = \"L\"\nup_5 = \"K\"\ndown_5 = \"J\"\n\n[normal_insert]\n# there is only `next` and `previous` and the order is not changable yet\nfocus_next = \"ctrl+i,ctrl+j\"\nfocus_previous = \"ctrl+o,ctrl+k\"\nunfocus = \"escape\"\n\n[normal]\nedit = \"i\"\ndelete = \"Q\"\nadd_note = \"o\"\nadd_box = \"O\"\n\n# For special characters like `+` or `\u003c` you need to use names\n# You can check the name using textual `textual keys`\n[resize_drawable]\nh_plus = \"greater_than_sign\"\nh_minus = \"less_than_sign\"\nv_plus = \"plus\"\nv_minus = \"minus\"\n\n# It brings at the top or bottom the note\n[bring_drawable]\nforward = \"ctrl+f\"\nbackward = \"ctrl+b\"\n\n[hoptex]\nfocus = \"ctrl+n\"\nquit = \"escape,ctrl+c\"\nunfocus = \"escape,ctrl+c\"\n```\n\n\u003c/details\u003e\n\n\n## Change Background Color in Left Sidebar\n\nBy default you can use `ctrl+e` to open Left Sidebar:\n\n![New note](https://raw.githubusercontent.com/Cvaniak/NoteSH/master/documentation/ChangeBackgroundColor.gif)\n\n## NEW FEATURES\n\n## TODO\n\nThere are many thigs to add! If you have idea, please create Issue with your suggestions.\n\n* [ ] Safe saving (now if there are any bugs you may lost your notes)\n* [x] Vim Key bindings\n  * Wait for feedback\n* [ ] Duplicate Note\n* [ ] Hiding menu (Color Picker etc.)\n* [x] TOML config file\n* [ ] Left Sidebar (for background and preferences)\n  * [x] Background color\n* [ ] Align tool for text\n* [ ] Fixed layers (if needed)\n* [ ] Diffrent Drawables:\n  * [ ] Check List\n  * [ ] Arrows\n* [ ] Help Screen\n* [ ] Command Pallet support \n* [ ] Menu to choose borders\n* [ ] Buttons to add new notes\n\nand also resolve problems:\n\n* [ ] Multiline Input (currently textual does not support it and here we have my hacky solution)  \n\n## Thanks\n\nBig thanks to [Will McGugan](https://github.com/willmcgugan) and all members and contributors of [Textualize.io](https://textualize.io)!\nGo checkout [Textual](https://github.com/Textualize/textual) amazing TUI framework on which this app is based.\n","funding_links":[],"categories":["Python","\u003ca name=\"note-taking\"\u003e\u003c/a\u003eNote taking"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCvaniak%2FNoteSH","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCvaniak%2FNoteSH","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCvaniak%2FNoteSH/lists"}