{"id":13817795,"url":"https://github.com/pouyakary/note","last_synced_at":"2025-05-15T20:32:56.525Z","repository":{"id":30393867,"uuid":"33946577","full_name":"pouyakary/note","owner":"pouyakary","description":"My pretty simple teminal note. Uses the Kary Framework for UI and has the coolest most awesome look. Is super simple and works with Dropbox and your cloud system...","archived":true,"fork":false,"pushed_at":"2017-12-13T19:18:42.000Z","size":113,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-05-19T10:10:44.436Z","etag":null,"topics":["c-sharp","cli","cross-platform","kary-comments","kary-framework","kf-coding-system","mono"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pouyakary.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-14T17:29:47.000Z","updated_at":"2023-01-28T20:31:12.000Z","dependencies_parsed_at":"2022-09-05T07:11:45.147Z","dependency_job_id":null,"html_url":"https://github.com/pouyakary/note","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouyakary%2Fnote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouyakary%2Fnote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouyakary%2Fnote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouyakary%2Fnote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pouyakary","download_url":"https://codeload.github.com/pouyakary/note/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254418795,"owners_count":22068153,"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":["c-sharp","cli","cross-platform","kary-comments","kary-framework","kf-coding-system","mono"],"created_at":"2024-08-04T06:00:55.902Z","updated_at":"2025-05-15T20:32:51.517Z","avatar_url":"https://github.com/pouyakary.png","language":"C#","readme":"\n![](http://kary.us/GitHubWideImages/note/screen.png) \n\n# Note\n\nI have always hated every single note / reminder / whatever application that was around. After writing the [Kary Framework](https://github.com/karyfoundation/framework-base), I started creating a very simple and pretty note software so that I could use for real. This is the result. \n\n## What's special about note?\n\n- Super easy to work with\n- Very minimal\n- One of the most complicated Kary Framework UI codes in history and really the most complicated Terminal UI layout of all time! (have you noticed the float divs inside it?)\n- Fully cross platform\n- Note uses plain text to store it's notes hence the end result is fully printable and rebate\n- Plain text storage \u0026rightarrow; so that you can put your storage in your Dropbox, iCloud, Google Drive or whatever you have!\n- Fully cross platform! with a cloud synced system you can even have your notes synced all over your devices!\n\n## How to use it\n\n#### Seeing your notes\n\nAfter you installed it you can read your notes using `note` command in terminal:\n\n```\n% note\n```\n\nThat will result:\n\n![](http://kary.us/GitHubWideImages/note/screen.png) \n\n\u003cbr/\u003e\n\n#### Adding notes\n\nTo add a new note you can simply write your note after the `note command` for example adding `hello world` will be:\n\n```\n% note hello world\n```\n\nFor the notes that inculde special characters bash may have problem with like `'` you can use the command:\n\n```\n% note add\n```\n\nAnd then a prompt like this will open:\n\n![](http://kary.us/GitHubWideImages/note/add.png) \n\nThere you can write a note like whatever that is in your mind!\n\n\u003cbr/\u003e\n\n#### Removing notes\nTo remove the note you can use `note rm` command, For example you want to remove note 2 and 5, You should use the `note rm` this way:\n\n```\n% note rm 2 5\n```\n\n\u003cbr/\u003e\n\n#### Editing notes\nEditing notes is just as easy. All you have to do to edit a note is to specify the note index after the `edit` command:\n\n```\n% note edit 12\n```\n\nAnd then thanks to the Kary Frameworks's text box implementation, the pervious note can be loaded into the input box as:\n\n![](http://kary.us/GitHubWideImages/note/edit.png) \n\n\n\n\u003cbr\u003e\u003cbr\u003e\n\n## Setting it up\n#### Step 1\nFirst of all you'll need to make an empty text file and name it whatever you want and save it in whatever form you want. In a UNIX system I would recommend perpending the name with a dot so the file goes hidden. Now for example the path to our file is \n\n```\n~/.notes\n```\n\nThis file is going to contain your notes so if you place it under your dropbox folder for example you'll get dropbox sync as well!\n\n\u003cbr/\u003e\n#### Step 2\nCreate a text file with this address:\n\n```\n~/.notepath\n```\nAnd write the address of your storage file in it. In our previous file we used `~/.notes` so let's use that (remember just the address no spacing of any kind - `tab`, `space`, `new line` - after it and before it)\n\n\u003cbr/\u003e\n#### Step 3\n\nDownload the note's release package from [Note's Release Page](https://github.com/pmkary/note/releases) (a zip file containing `Note.exe` and `Kary.Foundation.dll`), exact it and copy them together to whatever you want\n\n\u003cbr/\u003e\n#### Step 4\nMost of our job is done, We only need to make a shortcut for it. If you're using a good base like Linux you can simply edit the `.bashrc` file and add and alias to the binary but using this way you can do it anywhere including OS X and all UNIX based systems supporting \n\nDownload a copy of [run.vala](https://github.com/pmkary/run). Now replace this line:\n\n```C#\nstring ArcadeCommand = \"\u003cReplaceWithThePathOfYourArcadeDirectoryAndAddress\u003e\";\n```\n\nWith this:\n\n```C#\nstring ArcadeCommand = \"mono '\u003cwhere-you-copied-your-files\u003e'\";\n```\n\n**NOTE : ** Remember that the string must be `mono ' + the path of your file + '` like the example in the top\n\nNow compile the file using:\n\n```\nvalac -o name --pkg posix ./run.vala\n```\n\nSo the shortcut is ready now. You can install it in `/bin` or `/usr/local/bin` in a unix system (and there is no point to create a shortcut for Windows systems anyway...) like this:\n\n```\nsudo mv ./note /bin\n```\n\nOr the local bin (whatever...)\n\n\u003cbr /\u003e\n#### Step 5\nYou're all done! run `% note add` and have your first note!\n\n\u003cbr\u003e\u003cbr\u003e\n\n## License\n\n```\nNote - Super minimal terminal note app\nCopyright (c) 2015-2016 Pouya Kary \u003ck@arendelle.org\u003e\n\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n```\n\n","funding_links":[],"categories":["سی شارپ C♯"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpouyakary%2Fnote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpouyakary%2Fnote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpouyakary%2Fnote/lists"}