{"id":13562248,"url":"https://github.com/Standard-Unix-Notes/unix-notes","last_synced_at":"2025-04-03T18:33:09.693Z","repository":{"id":41804689,"uuid":"374587135","full_name":"Standard-Unix-Notes/unix-notes","owner":"Standard-Unix-Notes","description":"GPG encrypted notebooks. ","archived":false,"fork":false,"pushed_at":"2022-04-28T18:21:33.000Z","size":24151,"stargazers_count":10,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-04T14:44:32.561Z","etag":null,"topics":["gpg","gpg-encryption","notes","privacy"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Standard-Unix-Notes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/SECURITY.md","support":null}},"created_at":"2021-06-07T08:15:00.000Z","updated_at":"2024-10-20T22:48:16.000Z","dependencies_parsed_at":"2022-08-11T18:01:26.318Z","dependency_job_id":null,"html_url":"https://github.com/Standard-Unix-Notes/unix-notes","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Standard-Unix-Notes%2Funix-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Standard-Unix-Notes%2Funix-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Standard-Unix-Notes%2Funix-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Standard-Unix-Notes%2Funix-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Standard-Unix-Notes","download_url":"https://codeload.github.com/Standard-Unix-Notes/unix-notes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247056976,"owners_count":20876488,"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":["gpg","gpg-encryption","notes","privacy"],"created_at":"2024-08-01T13:01:06.237Z","updated_at":"2025-04-03T18:33:04.683Z","avatar_url":"https://github.com/Standard-Unix-Notes.png","language":"Shell","readme":"# Standard(?) Unix Notes\n\n## Background\nI have tried a number of different note systems over the years, from \nonline notes to Vim-wiki and Org-Mode and even just plain old text files. \nAll have their benefits and issues.   \n\nMore recently I have taken to GPG encrypting my notes in a process to \nimprove my overall security and privacy.  \n\nWhilst migrating my passwords into *Pass* the Standard Unix Password \nManager I was intrigued by the simplicity and ease of use in adding, \nmanaging and using passwords under this system.  \n\nThen this notes system started to brew in the back of my head. What if \nI replaced the password functionality of *pass* with a notes system. \nSure I could include my notes into *pass* with it's multi-line ability. \nBut as notes were added it would make accessing and managing my \npasswords more difficult. So I decided I really needed to keep my \npasswords and notes separate.      \n\nI decided to take the *pass* shell script and gut it, rename the \nfunctions and implement a system to encrypt/decrypt notes.  \n\nI use Yubikeys for my encryption and so have ensured that this script \nworks with the Yubikey 5 NFC, Yubikey 4 and the Yubikey NEO.\n\n## Features\n \n- Secure encrypted notes\n- Support for GPG resident keys on Yubikey and PIV cards\n- Easily add, rename, copy and delete notes\n- Import text files as notes directly into your working notebook\n- Switch between notebooks easily \n- Multiple notebooks support. Easily add, rename, copy and delete notebooks \n- Bash Completion for sub commands and note/notebook names\n\n\n## Licence\n\nThis application is licensed under the 3 clause BSD licence. See \n[LICENCE](LICENCE) for details.\n\n\n## Contributing to the Project\n\nContributions are welcome. Please see [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for details.\n\n\n## Notes and Notebooks\n\nThis Notes system supports multiple notebooks. \n\n- To manage your notes you simply use the *[notes](docs/USING_NOTES.md)* command.\n- To manage your notebooks you use the *[notebook](docs/MANAGING_NOTEBOOKS.md)* command.\n\n\n## Installing and Uninstalling\n\nAdding or removing this software is easy. See [docs/INSTALL.md](docs/INSTALL.md) \nor [UNINSTALL.md](UNINSTALL.md) for details.\n\n\n## Setup and configuration\n\nAfter installation you need to setup the environment. Standard Unix \nNotes does this with environment variables and the *[notes \ninit](docs/USING_NOTES.md)* command.\n\n\n## Managing Notes\n\nThe application manages notes in a similar way that Password-Store \nmanages passwords. To add/edit/import/rename/copy/delete notes you use \nthe appropriate sub-commands.\n\nFor example, to add a note you simply use \n\n```shell\n$ notes add this is my note title\n```\n\nThe *notes(1)* application automatically replaces spaces in the note title \nwith underscores.\n\nFor full details of commands available see \n[docs/USING_NOTES.md](docs/USING_NOTES.md) for details or view the \n*notes(1)* man page.\n\n\n## Changing GnuPG encryption keys\n\nEncryption keys do not last forever. From time to time they expire or \nbecome unsafe for some reason. \n\nWhen you need to change the encryption key for a file you would normally \ndecrypt and then re-encrypt it manually. Doing this for a series of \nfiles like you have in Notes would be a major pain. We have thought \nabout this scenario and can automate it.\n\nNotes has a special sub-command *newkey* to change the encryption keys \nof your notes. Using this command allows you to change the encryption \nkeys for all of your notes at once rather than having to change them \nmanually.\n\nSee [docs/USING_NOTES.md](docs/USING_NOTES.md) for details.\n\n\n## Managing Notebooks\n\nYou can have multiple notebooks to organise your notes. Each notebook is \njust a plain UNIX directory and so could be managed by standard UNIX \ndirectory tools. \n\nBut to make it easier we have provided a tool called *notebook* that has \na series of sub-commands for managing notebooks. See \n[docs/MANAGING_NOTEBOOKS.md](docs/MANAGING_NOTEBOOKS.md) for full details of the \ncommand and sub-commands.\n\n\n## Journals\n\nAlso included is a journal(1) system for encrypted journal entries. See \n[docs/JOURNAL.md](docs/JOURNAL.md) for details.\n\n\n## Yubikey Integration\n\nStandard Unix Notes supports GPG Keys on Yubikeys for GPG decryption. \nFor more details see [docs/YUBIKEYS.md](docs/YUBIKEYS.md).\n\n\n## PIV Integration\n\nFor more details on the proposed PIV integration see [docs/PIV.md](docs/PIV.md)\n\n---\n\n## RELEASE NOTES\n\nSee [docs/RELEASE-NOTES.md](docs/RELEASE-NOTES.md) for details.\n\n\n## ROADMAP\n\nSee [docs/ROADMAP.md](docs/ROADMAP.md) for details.\n\n\n## PACKAGING \n\nWe currently package for the following:\n\n- Source Tarball with makefile for installing \n- Debian .deb package suitable for Debian and Ubuntu based distributions\n\nWe are looking to package for other distributions depending on \navailability: see [docs/PACKAGING.md](docs/PACKAGING.md) for details.\n\n## BUGS \u0026 SECURITY\n\nSee [docs/SECURITY.md](docs/SECURITY.md) for details on our security policy and \n[docs/BUGS.md](docs/BUGS.md) for reporting bugs.\n","funding_links":[],"categories":["Applications","Notes","\u003ca name=\"note-taking\"\u003e\u003c/a\u003eNote taking"],"sub_categories":["Productivity"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStandard-Unix-Notes%2Funix-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FStandard-Unix-Notes%2Funix-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStandard-Unix-Notes%2Funix-notes/lists"}