{"id":19907349,"url":"https://github.com/dbluhm/bash-notes","last_synced_at":"2025-06-14T05:04:51.116Z","repository":{"id":114418689,"uuid":"96936482","full_name":"dbluhm/bash-notes","owner":"dbluhm","description":"A bash markdown note taking tool.","archived":false,"fork":false,"pushed_at":"2018-10-13T01:50:30.000Z","size":690,"stargazers_count":5,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-14T05:04:17.664Z","etag":null,"topics":["bash","bash-script","goyo","markdown","neovim","note-taking","notes"],"latest_commit_sha":null,"homepage":null,"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/dbluhm.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-11T20:56:13.000Z","updated_at":"2024-12-06T16:33:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"020f59f1-90fe-4b9f-b764-15a9db9ccf74","html_url":"https://github.com/dbluhm/bash-notes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dbluhm/bash-notes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbluhm%2Fbash-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbluhm%2Fbash-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbluhm%2Fbash-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbluhm%2Fbash-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dbluhm","download_url":"https://codeload.github.com/dbluhm/bash-notes/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbluhm%2Fbash-notes/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259763077,"owners_count":22907408,"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":["bash","bash-script","goyo","markdown","neovim","note-taking","notes"],"created_at":"2024-11-12T20:40:11.112Z","updated_at":"2025-06-14T05:04:51.096Z","avatar_url":"https://github.com/dbluhm.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"Notes\n============\n\nNotes is a simple CLI program for taking notes in Markdown using your preferred text editor.\n\nThis is mostly for my personal use. I'll admit to taking a few shortcuts so my code isn't the prettiest thing in the world. But it works for me.\n\nSuggested Dependencies\n--------------------------\n- I recommend using [Neovim](https://neovim.io/) as your editor with [Vim-Plug](https://github.com/junegunn/vim-plug) and [Goyo](https://github.com/junegunn/goyo.vim). Using Vim or NeoVim allows you to create and edit your notes exactly the way you want.\n- [Ag](https://github.com/ggreer/the_silver_searcher) is used for searching. It's faster than `grep`, which is used in it's place if `ag` can't be found.\n\n\nGetting Started\n---------------------\nThe `notes.sh` command will by default create your notes and notebooks inside of `$HOME/.notes`.\nYou can change this option by changing the value of `NOTESDIR` in `notes.sh`. Note that this value will also need to be changed in the notes_completion file as well or tab completion will not work.\n\n### Installation ###\nInstalling notes is incredibly simple. Just symlink `notes.sh` to an appropriate location like `~/.local/bin` as `notes`:\n\n```bash\nln -s ~/PATH_TO_NOTES_EXEC_DIR/notes.sh ~/.local/bin/notes\n```\n\nNext, in order to enable tab completion, notes_completion needs to be included by your `.bashrc` file. This is commonly done by including a whole `bash-completion.d` directory or simply sourcing the file.\n\nIf you use the `bash-completion.d` method, ensure something like the following is included in your `.bashrc` or `.profile`:\n\n```bash\n# Local bash completions\nif [ -d ~/.bash-completion.d ]; then\n    for f in ~/.bash-completion.d/*\n    do\n        source $f\n    done\nfi\n```\n\nThen make sure that `notes_completion` is symlinked into the `bash-completion.d` directory.\n\nIf you choose to just source `notes_completion` into your `.bashrc`, then the following is sufficient:\n\n```bash\n#Source notes_completion for tab completion\nsource ~/PATH_TO_NOTES_EXEC/notes_completion\n```\n\nYou should now be able to use the `notes` command and have tab completion.\n\n![Note taking demo](https://raw.githubusercontent.com/dbluhm/bash-notes/master/notes.gif)\n\n### Usage ###\n\n```\nUsage:\n        notes notebook [nested notebook ...] [note]\n                Edit or create a note. Omitting a note name will create a new note but\n                leave it unnamed.\n\n        notes [--search|-s] SEARCH_TERM\n                Search notes for SEARCH_TERM.\n\n        notes [--remove|-r] notebook [nested notebook ...] [note]\n                Remove an entire notebook or just a note within a notebook.\n\n        notes [--add|-a] [parent notebook ...] notebook\n                Create a new notebook\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbluhm%2Fbash-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdbluhm%2Fbash-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbluhm%2Fbash-notes/lists"}