{"id":19246222,"url":"https://github.com/mrossinek/notewarrior","last_synced_at":"2025-08-13T20:13:31.055Z","repository":{"id":111784711,"uuid":"156463747","full_name":"mrossinek/notewarrior","owner":"mrossinek","description":"terminal based note management","archived":false,"fork":false,"pushed_at":"2020-04-27T20:30:36.000Z","size":95,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-05T04:41:09.096Z","etag":null,"topics":["console-based","notes","notetaking","terminal-based"],"latest_commit_sha":null,"homepage":"https://gitlab.com/mrossinek/notewarrior","language":"Shell","has_issues":false,"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/mrossinek.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":"2018-11-06T23:45:59.000Z","updated_at":"2020-04-27T20:30:38.000Z","dependencies_parsed_at":"2023-04-23T12:05:16.951Z","dependency_job_id":null,"html_url":"https://github.com/mrossinek/notewarrior","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrossinek%2Fnotewarrior","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrossinek%2Fnotewarrior/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrossinek%2Fnotewarrior/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrossinek%2Fnotewarrior/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrossinek","download_url":"https://codeload.github.com/mrossinek/notewarrior/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240339488,"owners_count":19785956,"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":["console-based","notes","notetaking","terminal-based"],"created_at":"2024-11-09T17:30:58.047Z","updated_at":"2025-02-23T15:40:45.742Z","avatar_url":"https://github.com/mrossinek.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Notewarrior\n\nNotewarrior is a tool to help you manage your plain-text notes.\nIt has evolved a lot since it started out because I started using vimwiki more and more to actually organize and write my notes.\nThus, notewarrior has gotten to a point where it tries to get out of your way and only supplements the actual usage of vimwiki.\nIt does so by providing the following features:\n- allows basic add/edit/delete/list/show/open functionality for your notes\n- provides pandoc markdown integration for vimwiki by installing a custom `wiki2html_pandoc` binary\n- automatically tracks your Notes folder with [gitwatch](https://github.com/gitwatch/gitwatch)\n- using git it allows history rollback and undo/redo functionality\n- provides the [markdown2ctags](https://github.com/jszakmeister/markdown2ctags/blob/master/markdown2ctags.py) script to integrate well with [tagbar](https://github.com/majutsushi/tagbar)\n\n## Installation\n\nYou can install notewarrior by simply running:\n```sh\ngit clone https://gitlab.com/mrossinek/notewarrior.git\ncd notewarrior\nmake install\n```\n\n### Requirements\nPlease ensure that the following programs are installed:\n- `inotifywait` (commonly provided via [inotify-tools](https://github.com/inotify-tools/inotify-tools))  [required by `gitwatch`]\n- [pandoc](https://pandoc.org/)\n\n#### Optionally\n- [tree](http://mama.indstate.edu/users/ice/tree/)\n\n\n## Integration with [tagbar](https://github.com/majutsushi/tagbar)\n\nAdd the following to your vim configuration:\n\n```vim\n\" Add support for vimwiki markdown-based files in tagbar\nlet g:tagbar_type_vimwiki = {\n            \\ 'ctagstype': 'markdown',\n            \\ 'ctagsbin' : '/usr/local/bin/markdown2ctags',\n            \\ 'ctagsargs' : '-f - --sort=no --sro=::',\n            \\ 'kinds' : [\n            \\ 's:sections',\n            \\ ],\n            \\ 'sro' : '::',\n            \\ 'kind2scope' : {\n            \\ 's' : 'section',\n            \\ },\n            \\ 'sort': 0,\n            \\ }\n```\n\n\n## List of Commands\n- `init`: initialize note directory\n- `deinit`: removes all user data (use with care!)\n- `list`: list notes (with filters)\n- `show`: print note\n- `open`: open converted note (pdf/html argument)\n- `info`: show metadata about note (incl. history)\n- `add`: adds a note\n- `edit`: edits a note\n- `move`: moves an existing note\n- `delete`: deletes an existing note (or multiple)\n- `undo/redo`: un/redo last change (based on git history)\n\n## List of Configuration options\nConfiguration files may be placed in `~/.noterc` or `~/.config/notewarrior/config` or specified at runtime via the `-c \u003cCONFIG\u003e` command line option.\n\n- `DIRECTORY`: path to the notes directory (default: `~/.notes`)\n- `EXTENSION`: file extension for notes (default: `md`)\n- `ENABLE_GITWATCH`: whether to autostart gitwatch (default: `true`) [`true` or `false`]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrossinek%2Fnotewarrior","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrossinek%2Fnotewarrior","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrossinek%2Fnotewarrior/lists"}