https://github.com/jech/ical
Consult CalDav (iCalendar) calendars from the command line
https://github.com/jech/ical
caldav ical icalendar
Last synced: 10 months ago
JSON representation
Consult CalDav (iCalendar) calendars from the command line
- Host: GitHub
- URL: https://github.com/jech/ical
- Owner: jech
- License: mit
- Created: 2023-09-09T13:28:57.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-29T22:06:01.000Z (about 2 years ago)
- Last Synced: 2025-05-16T02:11:48.675Z (about 1 year ago)
- Topics: caldav, ical, icalendar
- Language: Go
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Consult CalDav (iCalendar) calendars from the command line
A command-line program to consult remote CalDav (iCalendar) calendars from
the command line. There is no caching and no need to synchronise
anything: `ical` sends requests directly to the remote server.
## Building
Say
```
go build -ldflags="-s -w"
```
Then copy the `ical` binary somewhere on your path.
## The configuration file
When you first start `ical`, it will complain about a missing configuration
file (`~/.config/ical/ical.json` under Unix). The file should look like this:
```
{
"endpoint": "https://cloud.example.org/remote.php/dav/calendars/username",
"username": "username",
"password": "password"
}
```
Omit `"username"` and `"password"` if no authentication is needed. If you
only want to consult a subset of calendars, add a field "calendars":
```
{
"endpoint": "https://cloud.example.org/remote.php/dav/calendars/username",
"username": "username",
"password": "password",
"calendars": ["personal"]
}
```
## Usage
Display all events in the next 7 days:
```
ical
```
Display all events in the next 31 days:
```
ical -duration month
```
Display all events in the next 3 days:
```
ical -duration 3
```
Display all events in the next 7 days together with their descriptions:
```
ical -v
```
List the user's calendars:
```
ical -list
```