{"id":15431253,"url":"https://github.com/mrusme/caldr","last_synced_at":"2025-09-21T00:59:08.405Z","repository":{"id":65197373,"uuid":"568518503","full_name":"mrusme/caldr","owner":"mrusme","description":"A lightweight CLI / TUI calendar that supports CalDAV","archived":false,"fork":false,"pushed_at":"2025-07-15T19:09:53.000Z","size":4624,"stargazers_count":48,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-09T21:39:12.799Z","etag":null,"topics":["caldav","caldav-client","calendar","cli","command-line","command-line-tool","tui","webdav","webdav-client"],"latest_commit_sha":null,"homepage":"https://xn--gckvb8fzb.com","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/mrusme.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"custom":["https://xn--gckvb8fzb.com/support/"]}},"created_at":"2022-11-20T19:25:38.000Z","updated_at":"2025-08-08T11:59:19.000Z","dependencies_parsed_at":"2024-01-07T21:02:37.386Z","dependency_job_id":"5782b92d-45e5-4a5c-beb0-2ba1908de6e3","html_url":"https://github.com/mrusme/caldr","commit_stats":{"total_commits":26,"total_committers":1,"mean_commits":26.0,"dds":0.0,"last_synced_commit":"05d14d3946feeeb813276488073aaa6d81fa3176"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/mrusme/caldr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Fcaldr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Fcaldr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Fcaldr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Fcaldr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrusme","download_url":"https://codeload.github.com/mrusme/caldr/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Fcaldr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276179897,"owners_count":25598571,"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-20T02:00:10.207Z","response_time":63,"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":["caldav","caldav-client","calendar","cli","command-line","command-line-tool","tui","webdav","webdav-client"],"created_at":"2024-10-01T18:21:22.018Z","updated_at":"2025-09-21T00:59:08.397Z","avatar_url":"https://github.com/mrusme.png","language":"Go","funding_links":["https://xn--gckvb8fzb.com/support/"],"categories":["\u003ca name=\"organizers\"\u003e\u003c/a\u003eOrganizers and calendars"],"sub_categories":[],"readme":"caldr\n-----\n\n![caldr](caldr.png)\n\n[\u003cimg src=\"https://xn--gckvb8fzb.com/images/chatroom.png\" width=\"275\"\u003e](https://xn--gckvb8fzb.com/contact/)\n\n`caldr`, the command line **cal**en**d**a**r**. It's super lightweight, yet it\nsupports CardDAV sync!\n\n## Build\n\n```sh\ngo build .\n```\n\n## Usage\n\nEither export all necessary variables to your ENV or set them as command line\nflags:\n\n```sh\nexport CARDDAV_USERNAME='...'\nexport CARDDAV_PASSWORD='...'\nexport CARDDAV_ENDPOINT='...'\nexport CALDR_DB='...'\n```\n\nIf you're using [Baïkal](https://github.com/sabre-io/Baikal) for example, you\nwould export something like this as `CARDDAV_ENDPOINT`:\n\n```sh\nexport CARDDAV_ENDPOINT='https://my.baik.al/dav.php/'\n```\n\nThe `CALDR_DB` is the local events database in order to not need to contact\nthe CalDAV for every lookup. You might set it to something like this:\n\n```sh\nexport CALDR_DB=~/.cache/caldr.db\n```\n\nWhen `caldr` is launched for the first time, it requires the `-r` flag to\nrefresh the events and sync them locally: \n\n```sh\ncaldr -r\n```\n\nThis way you could create a cron job that refreshes `caldr` in the background,\ne.g. every three hours:\n\n```sh\ncrontab -e\n```\n\n```crontab\n0 */3 * * * sh -c 'caldr -r'\n```\n\nYou can also output contacts as JSON format using the `-j` flag:\n\n```sh\ncaldr -j\n```\n\nFind more flags and info with `caldr --help`.\n\n\n## Templating\n\nYou can customize the regular output using templating. The template can either\nbe passed using the `--template \u003cfile\u003e` flag or by exporting `CALDR_TEMPLATE` \nin the in the environment.\n\nThe templating format is the [Go standard `text/template`][1] format.\n\nAvailable property names that are available can be found by checking the \n`CalEvent` struct in `store/store.go`.\n\nAn example template can be found [here][2]. To make use of the template, you can\ncopy it to e.g. `~/.config/caldr.tmpl` and have\n`CALDR_TEMPLATE=~/.config/caldr.tmpl` exported in your `.zshrc`/`.bashrc`/etc.\n\n\n## Notifications\n\nCheck my [dotfiles][5], especially [this script][6] for how to get notifications\nfor events. You could either run this script on login or periodically as a cron \njob.\n\n\n## FAQ\n\n- Q: Does `caldr` write/modify any contact information?\n  A: Nope, so far it's read-only and does not support updating iCals, hence it\n     won't mess with your data.\n- Q: Can I use it with my local calendar?\n  A: Nope, as of right now `caldr` only supports CalDAV servers to sync with.\n- Q: Does it support HTTP Digest auth?\n  A: Nope, only HTTP Basic auth.\n- Q: The `text/template` stuff doesn't work for me, can I make `caldr` output\n     contact data differently?\n  A: Yes, you can use the `-j` flag and have it output pure JSON, which you can\n     then process using e.g. [`jq`][4]. \n\n[1]: https://pkg.go.dev/text/template\n[2]: example.tmpl\n\n[4]: https://stedolan.github.io/jq/\n[5]: https://github.com/mrusme/dotfiles\n[6]: https://github.com/mrusme/dotfiles/blob/master/usr/local/bin/calendar-notifications\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrusme%2Fcaldr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrusme%2Fcaldr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrusme%2Fcaldr/lists"}