{"id":18640176,"url":"https://github.com/scotchman0/notes","last_synced_at":"2026-05-01T18:31:49.473Z","repository":{"id":44643894,"uuid":"367451751","full_name":"Scotchman0/notes","owner":"Scotchman0","description":"simple CLI notes-app, for quick-reference on the fly, like TLDR, CHEAT or MAN PAGES, but with your own entries for faster lookup.","archived":false,"fork":false,"pushed_at":"2025-03-31T16:37:29.000Z","size":96,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-27T02:04:05.329Z","etag":null,"topics":["bash","cheatsheet","editor","grep","library","manual","note-taking","notebook","notes","string-matching","tldr"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/Scotchman0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-05-14T18:42:13.000Z","updated_at":"2025-03-31T16:37:32.000Z","dependencies_parsed_at":"2025-05-17T15:42:19.672Z","dependency_job_id":null,"html_url":"https://github.com/Scotchman0/notes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Scotchman0/notes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scotchman0%2Fnotes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scotchman0%2Fnotes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scotchman0%2Fnotes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scotchman0%2Fnotes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Scotchman0","download_url":"https://codeload.github.com/Scotchman0/notes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scotchman0%2Fnotes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32508900,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["bash","cheatsheet","editor","grep","library","manual","note-taking","notebook","notes","string-matching","tldr"],"created_at":"2024-11-07T05:53:37.390Z","updated_at":"2026-05-01T18:31:49.442Z","avatar_url":"https://github.com/Scotchman0.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# notes\nsimple CLI notes-app, for quick-reference on the fly, like TLDR but with your own entries for faster lookup\n\nFeel free to use/modify/share/contribute\n\n~WR/Scotchman0\n\n# notes - your local library of quick notes\n \nnotes are stored by default in ~/my-notes \n\nsettings (like your default save path) and preferred editor/reader are managed in: ~/.notes.conf\n\nyou can edit the file directly with `notes settings`\n\n# Options you can configure:\n`notes settings` to open the settings panel and change the following:\n- Reader selection: uses CAT by default to print to cli, but can update to any other binary/executable or option set like 'glow -p' 'less' 'xdg_open' 'firefox' for example\n- editor: defaults to vi for universal access, but can be updated to anything that can write to text: nano, subl, etc\n- default file extension (default null) can define that notes save as markdown, txt, log, etc. \n- path to save notes in: defaults to ~/my-notes/ but you can redirect this anywhere more convenient like a common directory or secure log location.\n\nExample config setup:\n~~~\nmypath=~/my-notes #where you will save notes for query (leave out the trailing slash)\nmyeditor=vim #default editor for creating new notes with -n option\nmyreader=less #cat is default, can change to any other view option like less|subl|glow|\u003cyour_reader_app\u003e - accepts quoted commands\npathlength=\"$(echo $mypath/ | wc -m)\" #trims the start of the path so that -k only shares filenames\nnotes_extension= #left blank (default) can update a default for easy export - accepts .md|.log|.txt|etc\n~~~\n\n\n# getting started with notes: \n1. clone this repository\n2. make notes executable with $ sudo chmod a+x ./notes\n3. make a softlink in ~/bin:\n\u003e ln -s ~/path/to/github/notes/notes ~/bin/notes\n\nthis makes the executable 'notes' immediately available if ~/bin is a part of your $PATH\n\n4. type 'notes' into commandline and press return to create the default conf variables and default save location, then modify ~/.notes.conf if desired. \n5. type 'notes -h' for help or 'notes example' for a welcome file example that provides options on getting started + basic usage.\n\n# updating notes:\n1. delete ~/.notes.conf\n2. run a git pull command: $ sudo git pull\n3. call the command 'notes' if you've added the download location to your $PATH variable, or run locally: ./notes\n4. it will replace ~/.notes.conf with an updated version (this is important -variables have been modified in versions v5 and later).\n5. use notes like normal, and reference 'notes -h' for updated use list as applicable.\n\n# USAGE:\n\n`notes {options} {note-name}`\n\n\n~~~\n settings                  opens the ~/.notes.conf file for modification\n -h, --help                show brief help\n -l, --list= LIST NOTES    list all note titles (tab doesn't populate until next shell launch)\n -g, --grep=GREP STRING    greps match + 2 lines following in library (-i is enabled so not exact match)\n -k, --search              searches for string match (use quotes) and displays note titles with positive hit\n -n, --new=NEW NOTE/edit   opens ${editor} in /home/sunbro/my-notes/\u003cnote_name\u003e (sets a filetype extension if set in settings)\n -e, --edit                opens ${editor} in /home/sunbro/my-notes/\u003cnote_name\u003e but does not append a filetype extension\n -d, --delete              deletes note: notes -d \u003cnote_name\u003e --\u003e (ask to confirm=true)\n -d! --delete!             delete without asking: notes -d! \u003cnotename\u003e  --\u003e (deleted)\n -p  --print | print       prints content of note directly to stdout instead of opening it with a reader for copy/paste\n\nexamples: \n`notes -n testnote` #create (or edit) a note named: `testnote`\n`notes settings` #open settings panel for adjusted configuration options\n\n~~~\n \n ![Screenshot_20210824_122451](https://user-images.githubusercontent.com/35974491/130654524-59f26288-1fba-44a8-b461-162695795020.png)\n \n\ntry the command: 'notes example' for getting started\n\n\n\n# tab auto-completion:\n\nI have implemented a line in the ~/.notes.conf file that will enable tab completions following 'notes' command to reference the library. \nHowever, it is sourced at shell launch, (which means your tab-list will only refresh when you launch a new shell session for now. use notes -l to see all notes if you don't want to leave session to refresh) and requires an appendation to your ~/.bashrc or ~/.zshrc profile:\n\nto enable tab completion simply follow the prompts during first time use, or if setting up later:\n\n\u003e echo \". ~/.notes.conf\" \u003e\u003e ~/.bashrc\n \n \n # EXAMPLE of quick recall/match/grep features:\n \n![Screenshot_20210824_122737](https://user-images.githubusercontent.com/35974491/130654683-d4eb0a44-6300-4509-9d38-e08c88211d09.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscotchman0%2Fnotes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscotchman0%2Fnotes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscotchman0%2Fnotes/lists"}