{"id":29866523,"url":"https://github.com/ficd0/jrnl.fish","last_synced_at":"2025-07-30T12:39:42.263Z","repository":{"id":289427038,"uuid":"971193661","full_name":"ficd0/jrnl.fish","owner":"ficd0","description":"MIRROR OF https://git.sr.ht/~ficd/jrnl.fish","archived":false,"fork":false,"pushed_at":"2025-04-24T03:14:45.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-22T04:35:22.489Z","etag":null,"topics":["fish","fish-plugin"],"latest_commit_sha":null,"homepage":"https://git.sr.ht/~ficd/jrnl.fish","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/ficd0.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,"zenodo":null}},"created_at":"2025-04-23T06:47:20.000Z","updated_at":"2025-04-24T03:14:48.000Z","dependencies_parsed_at":"2025-05-12T21:18:14.351Z","dependency_job_id":"08bc833d-5d6f-4d97-8ade-882033437443","html_url":"https://github.com/ficd0/jrnl.fish","commit_stats":null,"previous_names":["ficcdaf/jrnl.fish","ficd0/jrnl.fish"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ficd0/jrnl.fish","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ficd0%2Fjrnl.fish","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ficd0%2Fjrnl.fish/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ficd0%2Fjrnl.fish/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ficd0%2Fjrnl.fish/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ficd0","download_url":"https://codeload.github.com/ficd0/jrnl.fish/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ficd0%2Fjrnl.fish/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267867871,"owners_count":24157369,"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-07-30T02:00:09.044Z","response_time":70,"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":["fish","fish-plugin"],"created_at":"2025-07-30T12:39:39.576Z","updated_at":"2025-07-30T12:39:42.229Z","avatar_url":"https://github.com/ficd0.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jrnl.fish\n\n\u003e Fishy journaling 🐟\n\u003e\n\u003e Part of my [utilities](https://sr.ht/~ficd/utils/) collection.\n\n`jrnl` is a simple Fish utility for journaling in Markdown. It creates daily\njournal entries based on a template. The `jrnl` command opens today's entry in\nyour `$EDITOR`, making it easy to journal any time!\n\n- [Usage](#usage)\n  - [Template](#template)\n- [Installation](#installation)\n- [Acknowledgements](#acknowledgements)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Usage\n\nTo get started, simply run `jrnl`. You'll be prompted to edit and save the\ndefault template if one doesn't already exist.\n\nTo open today's entry, creating it if it doesn't yet exist:\n\n```fish\njrnl\n```\n\nBy default, the next day starts at 3 AM. To change this, you can set the offset\nyourself. For example, an offset of 0 means the next day starts at midnight,\nwhile an offset of 6 makes the day start at 6 AM, etc.\n\n```fish\n# via environment variable for persistance\nset -Ug jrnl_offset 0\n# or command option\njrnl -o 0\njrnl --offset 0\n```\n\nTo edit the template at any time:\n\n```fish\njrnl -e\njrnl --edit-template\n```\n\nTo set the journal directory (`~/jrnl` by default):\n\n```fish\n# via environment variable for persistance\nset -Ug jrnl_directory /path/to/journal\n# or via command option\njrnl -d path/to/journal\njrnl --dir path/to/journal\n```\n\nTo set the template file (relative to the journal directory, `template.md` by\ndefault):\n\n```fish\n# via environment variable for persistance\nset -Ug jrnl_template template_name.md\n# or via command option\njrnl -t template_name.md\njrnl --template template_name.md\n```\n\nTo show the help menu:\n\n```fish\njrnl -h\njrnl --help\n```\n\n### Template\n\n`jrnl.fish` implements a very basic template system.\n\nIf the specified template file cannot be resolved, the journal directory is\nsearched with `fd` for a matching file. If there is no such template, the\ndefault `template.md` will be used.\n\nMarkdown comments are skipped, and extra newlines at the end of the file are\ntrimmed. The following literals are substituted:\n\n- `%{date}`\n  - Short date: `2025-04-23`.\n- `%{date_long}`\n  - Long date: `Wednesday, Apr 23, 2025`.\n\n## Installation\n\nTo install directly, you can download [jrnl.fish](./functions/jrnl.fish) and\nplace it inside your `$fish_config/functions`:\n\n```fish\ncurl https://git.sr.ht/~ficd/jrnl.fish/blob/mail/jrnl.fish \\\n    -o $fish_config/functions/jrnl.fish\n```\n\nYou can also use Fisher to install from the GitHub mirror:\n\n```fish\nfisher install ficcdaf/jrnl.fish\n```\n\n## Acknowledgements\n\n- Will Munslow's original [jrnl](https://github.com/subterrane/jrnl) script.\n\n## Contributing\n\nPlease submit patches, questions, and discussion points to the\n[mailing list](https://lists.sr.ht/~ficd/utils), and make bug reports and\nfeature requests on the [ticket tracker](https://todo.sr.ht/~ficd/utils).\n\n## License\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fficd0%2Fjrnl.fish","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fficd0%2Fjrnl.fish","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fficd0%2Fjrnl.fish/lists"}