{"id":20680155,"url":"https://github.com/nebkor/joenal","last_synced_at":"2025-06-26T07:02:21.494Z","repository":{"id":139504924,"uuid":"151318599","full_name":"nebkor/joenal","owner":"nebkor","description":"A tiny framework for microjournaling","archived":false,"fork":false,"pushed_at":"2021-07-02T01:04:21.000Z","size":378,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-20T00:48:14.476Z","etag":null,"topics":["journaling","personal-utility","productivity","rust-lang","shell","sqlite","terminal","workflows"],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nebkor.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-10-02T20:26:20.000Z","updated_at":"2024-05-23T19:35:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"27dfa72d-24cc-468a-a0d2-235092c53535","html_url":"https://github.com/nebkor/joenal","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nebkor/joenal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebkor%2Fjoenal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebkor%2Fjoenal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebkor%2Fjoenal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebkor%2Fjoenal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nebkor","download_url":"https://codeload.github.com/nebkor/joenal/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebkor%2Fjoenal/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262018675,"owners_count":23245618,"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":["journaling","personal-utility","productivity","rust-lang","shell","sqlite","terminal","workflows"],"created_at":"2024-11-16T21:29:43.554Z","updated_at":"2025-06-26T07:02:21.473Z","avatar_url":"https://github.com/nebkor.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# About\n\njoenal (formerly \"jotlog\") is a simple framework for microjournaling.\n\n## No really, what?\n\nIt's currently a collection of small Rust programs that interact with a sqlite3 database to support\nvarious Memex-related-or-adjacent functions, such as recording a small note, or retrieving such a\nnote. The notes have tags, and I'm planning on adding parent/child relationships for note entries,\nto enable \"how to take smart notes\"-style personal knowledge management workflows. Eventually, there\nwill be a standard for plugins that can create new tables, such as for a spaced repitition system.\n\n# Getting started\n\nHonestly, you probably don't even wanna bother. But if you insist...\n\nTo create entries in your joenal database, there is a simple program called `joenal-insert`:\n\n``` text\nJoenal Insert\nCreate and insert an entry into the joenal database.\n\nUSAGE:\n    joenal-insert [FLAGS] [OPTIONS]\n\nFLAGS:\n        --headless    Do not prompt for input.\n    -h, --help        Prints help information\n    -V, --version     Prints version information\n\nOPTIONS:\n    -m, --message \u003cMESSAGE\u003e    Message fragment to prepend to entry.\n    -t, --tag \u003cTAGS\u003e...        Add tag to entry; may be specified more than once for more than one tag.\n```\n\nIt's not intended to necessarily be invoked directly, but rather wrapped via shell scripts or other\nprograms. See the ```bin/joenal``` shell script for an example of an interactive wrapper script.\n\nSemantically, each entry is a timestamp, a message, and a collection of tags. Tags may have spaces,\nsince they're comma-separated on entry with this program. They may also be given one at a time on\nthe command-line with repeated uses of the ```-t``` option. A message fragment may also be given as\na string with the ```-m``` option, though it may be used only once. Both the message and the tags\nmay be added to when `joenal` is invoked without ```--headless```.\n\nIn terms of workflows, the ```joenal``` shellscript is meant to be used to dash a note off to\nyourself. There's a git ```post-commit``` hook in the \"git-hooks\" directory as an example of using\nthe ```headless``` mode for automated journaling.\n\n## Installing and Using\n\nUse ```cargo build --release``` to build the two binaries under ```src/bin```; they will be in\n```target/release/[joenal-insert|joenal-read|joenal-gui]```. I recommend copying them to your\n```${HOME}/bin``` directory and changing their name to start with an underscore (the shell wrapper\nand git hook assume the main binaries are thus named).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnebkor%2Fjoenal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnebkor%2Fjoenal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnebkor%2Fjoenal/lists"}