{"id":15035179,"url":"https://github.com/plbstl/journal","last_synced_at":"2026-03-27T04:58:11.351Z","repository":{"id":47775254,"uuid":"395422216","full_name":"plbstl/journal","owner":"plbstl","description":"📔 Preserve your memories, self-reflect and record ideas on-the-go with Journal.","archived":false,"fork":false,"pushed_at":"2021-08-13T20:03:27.000Z","size":169,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-20T06:43:24.923Z","etag":null,"topics":["cli","go","journal"],"latest_commit_sha":null,"homepage":"https://paulebose.github.io/journal/","language":"Go","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/plbstl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-12T19:20:32.000Z","updated_at":"2024-07-16T16:30:07.000Z","dependencies_parsed_at":"2022-09-26T20:10:48.355Z","dependency_job_id":null,"html_url":"https://github.com/plbstl/journal","commit_stats":null,"previous_names":["paulebose/journal"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plbstl%2Fjournal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plbstl%2Fjournal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plbstl%2Fjournal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plbstl%2Fjournal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/plbstl","download_url":"https://codeload.github.com/plbstl/journal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243384334,"owners_count":20282337,"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":["cli","go","journal"],"created_at":"2024-09-24T20:27:44.935Z","updated_at":"2025-12-29T02:36:06.039Z","avatar_url":"https://github.com/plbstl.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n \u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/6/63/Journal_Icon.svg\" height=200 alt=\"Journal\"/\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003eJournal\u003c/h3\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![Release][release-badge]][release-link]\n[![GitHub Issues][gh-issues-badge]][gh-issues-link]\n[![GitHub Pull Requests][gh-pulls-badge]][gh-pulls-link]\n[![GitHub contributors][gh-contributors-badge]][gh-contributors-link]\n[![License Badge][license-badge]][license-link]\n[![PkgGoDev][pkg-godev-badge]][pkg-godev-link]\n\n\u003c/div\u003e\n\n---\n\n\u003cp align=\"center\"\u003e📔 Preserve your memories, self-reflect and record ideas on-the-go.\u003c/p\u003e\n\n## 📝 Table of Contents\n\n-   [About \u003ca name = \"about\"\u003e\u003c/a\u003e](#about)\n-   [Getting Started](#getting-started)\n-   [Usage](#usage)\n-   [Contributing](#contributing)\n-   [Authors](#authors)\n-   [Acknowledgement](#acknowledgement)\n\n## 🧐 About \u003ca name = \"about\"\u003e\u003c/a\u003e\n\nJournal helps you manage multiple journals with ease from the comfort of your terminal, web browser or API client.\nYou can import/export journals as [horcruxes](https://en.wikipedia.org/wiki/Magical_objects_in_Harry_Potter#Horcruxes) and set simple customizations for layout, theme, and keybindings.\n\nJournal brings out the quintessence of your potent yet pervious mind.\nGet personal with it and use its gorgeous powers for good.\n\n\u003c!-- @todo: create screencasts for cli \u0026 web --\u003e\n\n\u003cdiv align=\"center\"\u003e\n\nCli Screencast\n\n\u003c!-- ![Cli Screencast](docs/resources/cli-demo.gif) --\u003e\n\n![Cli Screencast](https://media.giphy.com/media/jRlP4zbERYW5HoCLvX/giphy.gif)\n\nWeb Screencast\n\n\u003c!-- ![Web Screencast](docs/resources/web-demo.gif) --\u003e\n\n![Web Screencast](https://media.giphy.com/media/IwTWTsUzmIicM/giphy.gif)\n\n\u003c/div\u003e\n\n## 🏁 Getting Started \u003ca name=\"getting-started\"\u003e\u003c/a\u003e\n\n\u003c!-- @todo: upload live demo; edit live-demo-link --\u003e\n\nCheck out [live demo][live-demo-link] of web app.\n\n### Installing\n\n#### Binary Release\n\nYou can download a binary release for Windows, Mac or Linux [here][release-link].\n\n#### Using Go Get\n\n```sh\ngo get -u github.com/paulebose/journal\n```\n\nIf you get an error claiming that _journal_ command cannot be found or is not defined, you\nmay need to add `~/go/bin` to your _\\$PATH_. `~/go/bin` should not be mistaken for `$GOROOT/bin` (which is for Go's own binaries,\nnot installed apps like _journal_).\n\n## 🎈 Usage \u003ca name=\"usage\"\u003e\u003c/a\u003e\n\nHere is some basic usage information for terminal.\n\n### Commands\n\nCreate and open a new note with the default author:\n\n```sh\njournal new\n```\n\nCreate a new note with a custom id:\n\n```sh\njournal create note --id custom-id\n```\n\nCreate a new author:\n\n```sh\njournal create author\n```\n\nEdit an author or tag:\n\n```sh\njournal edit \u003cid\u003e\n```\n\nRun `journal help` for more information.\n\n```sh\njournal help\n```\n\n### Keybindings\n\n\u003cpre\u003e\n  \u003ckbd\u003er\u003c/kbd\u003e refresh list\n  \u003ckbd\u003eh\u003c/kbd\u003e show help\n  \u003ckbd\u003et\u003c/kbd\u003e toggle screen mode (normal/half/fullscreen)\n  \u003ckbd\u003e,\u003c/kbd\u003e show settings\n  \u003ckbd\u003e/\u003c/kbd\u003e search\n  \u003ckbd\u003ex\u003c/kbd\u003e select item\n  \u003ckbd\u003eQ\u003c/kbd\u003e quit\n  \u003ckbd\u003eesc\u003c/kbd\u003e close current panel\n\u003c/pre\u003e\n\nCheck the [keybindings docs](docs/KEYBINDINGS.md) for more information.\n\n### Configuration\n\nDefault path for config file:\n\n-   Windows: `C:\\Users\\USERNAME\\AppData\\Roaming\\Journal\\config.yml`\n-   MacOS: `/Users/USERNAME/Library/Application Support/Journal/config.yml`\n-   Linux: `/home/USERNAME/.config/Journal/config.yml`\n\n```yaml\n# Example Config\ncli:\n    mouseEnabled: true\n    editor: 'in-built'\n    confirmOnQuit: false\n    keybindings:\n        # command: 'key'\nweb:\n    port: 9001\n```\n\nCheck the [configuration docs](docs/CONFIG.md) for more information.\n\n## 🤿 Contributing \u003ca name = \"contributing\"\u003e\u003c/a\u003e\n\nContributors are welcome! Please check out the [contributing guide](CONTRIBUTING.md).\nFor discussions about stuff, you can use [GitHub Discussions][gh-discussions-link]\n\n## ✍️ Authors \u003ca name = \"authors\"\u003e\u003c/a\u003e\n\n-   [@PaulEbose](https://github.com/PaulEbose) - Idea \u0026 initial work\n\nSee also the list of [contributors][gh-contributors-link] who participated in this project.\n\n## 🎉 Acknowledgements \u003ca name = \"acknowledgement\"\u003e\u003c/a\u003e\n\n-   Influence: [@Richmond-Eribo](https://github.com/Richmond-Eribo)\n\n[license-badge]: https://img.shields.io/github/license/paulebose/journal\n[license-link]: LICENSE.md\n[live-demo-link]: https://example.org\n[pkg-godev-badge]: https://pkg.go.dev/badge/github.com/PaulEbose/journal\n[pkg-godev-link]: https://pkg.go.dev/github.com/PaulEbose/journal\n[gh-contributors-badge]: https://img.shields.io/github/contributors/paulebose/journal\n[gh-contributors-link]: https://github.com/PaulEbose/journal/graphs/contributors\n[gh-discussions-link]: https://github.com/PaulEbose/journal/discussions\n[gh-issues-badge]: https://img.shields.io/github/issues/paulebose/journal\n[gh-issues-link]: https://github.com/paulebose/journal/issues\n[gh-pulls-badge]: https://img.shields.io/github/issues-pr/paulebose/journal\n[gh-pulls-link]: https://github.com/paulebose/journal/pulls\n[release-badge]: https://img.shields.io/github/v/release/PaulEbose/journal?sort=semver\n[release-link]: https://github.com/PaulEbose/journal/releases\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplbstl%2Fjournal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplbstl%2Fjournal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplbstl%2Fjournal/lists"}