{"id":24122167,"url":"https://github.com/tlinden/note","last_synced_at":"2025-09-18T11:32:50.073Z","repository":{"id":144613051,"uuid":"3409992","full_name":"TLINDEN/note","owner":"TLINDEN","description":"a perl script for maintaining notes","archived":false,"fork":false,"pushed_at":"2024-09-24T16:41:25.000Z","size":653,"stargazers_count":4,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-01T17:09:27.082Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://www.daemon.de/NOTE","language":"Perl","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/TLINDEN.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog","contributing":null,"funding":null,"license":null,"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":"2012-02-10T18:55:14.000Z","updated_at":"2024-09-24T16:41:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"08fc1e53-e5b2-4a28-80e5-47a7471b34b8","html_url":"https://github.com/TLINDEN/note","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/TLINDEN/note","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TLINDEN%2Fnote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TLINDEN%2Fnote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TLINDEN%2Fnote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TLINDEN%2Fnote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TLINDEN","download_url":"https://codeload.github.com/TLINDEN/note/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TLINDEN%2Fnote/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275757840,"owners_count":25523110,"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","status":"online","status_checked_at":"2025-09-18T02:00:09.552Z","response_time":77,"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":[],"created_at":"2025-01-11T11:38:43.904Z","updated_at":"2025-09-18T11:32:50.059Z","avatar_url":"https://github.com/TLINDEN.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# note - a perl script for maintaining notes.\n\nThis is the perl script 'note' in version 1.4.2 from 24/09/2024.\n\n## Introduction\n\nThis is a  small console program written in perl,  which allows you to\nmanage notes similar to programs like \"knotes\" from command line.\n\nThere are a couple of different  databases backends, which you can use\nwith note:\n\n* **binary** - this is the default backend\n  and uses a binary file to store your notes.\n* **mysql** - this backend uses a mysql\n  database to store your notes. You can switch\n  easily to another DBMS since this module uses\n  the Perl standard module \"DBI\" for database-\n  access. See below for more info on this topic!\n* **dbm** - this module uses two DBM files\n  for data storage and requires the module DB_FILE,\n  which is part of the perl standard distribution.\n  See below for more details about the DBM module.\n* **general** - uses the module Config::General\n  for storage, which makes the data file portable,\n  since it is a plain ascii file (binary content\n  will be base64 encoded).\n* **text** - uses the Storable module for data\n  storage (a serializer). Storable is included with\n  perl, and since it's written in C, it's very fast.\n  But the resulting data files are not that portable\n  as the once of NOTEDB::general are.\n* **pwsafe3** - uses the\n  [PWSAFE3](https://github.com/pwsafe/pwsafe/blob/master/docs/formatV3.txt)\n  file format, which is securely encrypted. The file can be opened\n  with any other program which supports the format. There are windows\n  programs and apps for mobile phones available. **I highly recommend\n  to use this backend if you ever intend to store sensitive\n  information in it!**\n\n## Where to \n\nYou can download the source at http://www.daemon.de/NOTE or\nhttps://github.com/tlinden/note.\n\nIf you are using debian, you run `can apt-get ìnstall note`.\n\nIf you are using gentoo, you can emerge it.\n\n\n\n## Features\n\n* Several different database backends, mysql(DBI), dbm,\n  binary (bin file), general and text (text files).\n* Command line interface using the standard perl module\n  Getopt::Long, which allows you to use short or long\n  command-line options.\n* Interactive interface (pure ascii), the following functions\n  are available in interactive mode: list, display, topic,\n  delete, edit, help.\n* Highly configurable using a perlish configfile ~/.noterc.\n  although it is configurable it is not required, note can\n  run without a configfile using useful default presets.\n* Colourized output is supported using ASCII Escape-Sequences.\n* The user can customize the color for each item.\n* Data can be stored in various different database backends,\n  since all database access is excluded from the program itself\n  in perl modules.\n* Notes can be deleted, edited and you can search trough your notes.\n* Notes can be categorized. Each category (topic) can contain multiple\n  notes and even more sup-topics. There is no limitation about\n  sub topics.\n* You can view all notes in a list and it is possible only to view\n  notes under a certain topic.\n* There is a tree-view, which allows you to get an overview of your\n  topic-hierarchy.\n* Notes can be encrypted using DES or IDEA algorithms and Crypt::CBC.\n* You can dump the contents of your note database into a plain text\n  file, which can later be imported. Imports can be appended or it can\n  overwrite an existing database (`-o`).\n* Note has scripting capabilities, you can create a new note by piping\n  another commands output to note, you can also import a notedump from\n  stdin as well es duming to stdout instead a file. Additional, there \n  is an option `--raw` available, which prints everything out completely\n  without formatting.\n* for better performance, note can cache the database for listings\n  or searching.\n* It can be installed without root-privileges.\n* If Term::ReadLine (and Term::ReadLine::Gnu) is installed, history\n  and auto-completion are supported in interactive mode.\n* Last, a while ago a user stated: \"... it simply does, what it\n  says ...\"\n\n\n\n## Requirements\n\nYou need the following things:\n\n* perl installed (5.004x)\n* The module IO::Seekable and Fcntl, which should be \n  already installed with your perl distribuion if\n  you want to use the binary database backend.\n* DBI module and DBI::mysql if you want to use the \n  mysql database backend.\n* The module DB_FILE if you want to use the DBM module.\n* Getopt::Long (part of perl std distribution)\n* Term::ReadLine and optionally Term::ReadLine::Gnu if\n  you want to use the auto-completion and history functionality.\n* Config::General if you want to use the NOTEDB::general\n  backend.\n* YAML is needed to create backups using -D. Please note,\n  that this format is deprecated starting with 1.4.0. \n  \n  **The support will be removed in 1.5.0. Please switch to JSON\n  format as soon as possible, either by using the -j\n  commandline option or the UseJSON configuration value.**\n* The Crypt::PWSafe3 module if you want to use the pwsafe3 backend.\n\n## Installation\n\nUnpack the tar-ball and issue the following command:\n\n`$ perl Makefile.PL`\n\nThis creates the Makefile neccessary for installing.\nYou may add some additional variables to the command line, the\nmost important one is PREFIX.\n\nThen enter the following command to prepare the installation\nprocess:\n\n`$ make`\n\nAfter that, you are ready to install. Become root and issue:\n\n`# make install`\n\nThe installation process installs all modules for every available\ndata backends. The default note configuration does not require\nadditional perl modules.\nIf you want to use the mysql backend refer to the installation\ninstructions for the mysql database installation in mysql/README.\n\nIf you want to use encryption support, you will need at least\nCrypt:CBC and Crypt::Blowfish (or Crypt::DES or whatever you\nprefer). You won't need to manually install any of this if you want to\nuse the pwsafe3 backend, in that case install Crypt::PWSafe3 with all\nits dependencies.\n\n\n\n## Configuration\n\nThis  version  of  note   doesn't  necessarily  need  a  configuration\nfile. But you can have one and change some default values. Take a look\nat  the  file config/noterc  provided  with  this tarball.  There  are\ndetailed instructions  about every  available parameter.   Simply copy\nthis file into your home-directory and name it `.noterc` If you decide\nnot to  use the  default database  backend (a  binary file),  you will\n*need* a configuration!\n\n\n## Usage\n\nRefer to the note(1) manpage for usage instructions.\n\n\n## Getting help\n\nAlthough I'm happy  to hear from note users  in private email,\nthat's the best way for me to forget to do something.\n\nIn order to report a bug,  unexpected behavior, feature requests or to\nsubmit    a    patch,    please    open   an    issue    on    github:\nhttps://github.com/TLINDEN/note/issues. \n\n## Deprecation notes\n\nThe **binary** database format will be removed with version 1.5.0. No\ndeprecation note is being printed for now.\n\nThe **text** database format will be either removed or will use\nanother backend module for security reasons. The perl module Storable\nwill not be used anymore.\n\n## Copyright and License\n\nCopyright (c) 1999-2013 Thomas Linden\nCopyright (c) 2013-2024 Thomas von Dein\n\nLicensed under the GNU GENERAL PUBLIC LICENSE version 3.\n\nYou can read the complete GPL at: http://www.gnu.org/copyleft/gpl.html\n\n## Author\n\nT.v.Dein \u003ctom AT vondein DOT org\u003e\n\n\n## Contributors / Credits\n\nShouts to all those guys who helped me to enhance note: THANKS A LOT!\n\nJens Heunemann \t- sub tree.\nPeter Palmreuther - various additions.\n\nAnd many other people who sent bug reports, feature requests. If you\nfeel that I forgot your name in this list, then please send me an email\nand I'll add you.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftlinden%2Fnote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftlinden%2Fnote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftlinden%2Fnote/lists"}