Skip to content

Latest commit

 

History

History
99 lines (68 loc) · 3.94 KB

ical.md

File metadata and controls

99 lines (68 loc) · 3.94 KB
Raw

Creating iCalendar Files

ical-git's simple design means it does not directly create iCalendar files. Instead, it relies on external sources to generate these files. Common sources include:

  • Emails: Many email clients and services allow you to create calendar events directly from email invitations. These events can be exported as iCalendar files.
  • Appointments: Calendar applications like Google Calendar, Outlook, or Apple Calendar can create and export events in the iCalendar format.
  • Language Models (LLMs): Private LLMs can be used to generate iCalendar content based on simple instructions.
  • copy and modify existing iCalendar files from the testdata directory to suit your needs:

Export the calendar event or generate the content from the LLM in the iCalendar format (.ics file) and save the generated or exported .ics file in the directory specified in your icalgit.toml configuration file.

ical-git special features

Add Images (ATTACH property)

When creating iCalendar files, you can add images for notifications by using the ATTACH property in the .ics file. The value of this property can be either an external URL or a reference to an image defined in the images property of the configuration file.

Example:

ATTACH:https://example.com/path/to/image.png

For more details on configuring images, refer to the Configuration File documentation.

Comments (COMMENT property)

In iCalendar files, you can use multiple COMMENT properties to provide additional information about an event. ical-git will display only one of these COMMENT lines in the notification, making it useful for events without exact dates or composed of many loosely related tasks.

Example:

COMMENT:Task 1: Prepare materials
COMMENT:Task 2: Schedule meeting
COMMENT:Task 3: Follow up

Disable dates (CATEGORIES property)

When creating iCalendar files, you can use the CATEGORIES property to categorize your events. ical-git will display all categories associated with an event. Additionally, you can use a special category named "no-dates" to disable the display of dates in the notifications.

Example:

CATEGORIES:Work
CATEGORIES:Meeting
CATEGORIES:no-dates

Managing iCal Files

It is highly advisable to place your iCal files under revision control to ensure that changes are tracked and can be reverted if necessary.

Additionally, setting up a cron job to periodically pull the latest content of these files can help keep your calendar up-to-date.

Setting Up Revision Control

  1. Initialize a Git Repository: Navigate to your iCal files directory and initialize a Git repository.

    cd /home/icalgit/icalgit/my-ical-files
git init

  2. Add and Commit Your Files: Add your iCal files to the repository and commit them.

    git add .
git commit -m "Initial commit of iCal files"

  3. Push to a Remote Repository: If you have a remote repository (e.g., on GitHub), push your local repository to the remote.

    git remote add origin git@github.com:yourusername/your-repo.git
git push -u origin main

Setting Up a Cron Job

To ensure your iCal files are periodically updated, you can set up a cron job to pull the latest content from your revision control system.

  1. Edit Your Crontab: Open your crontab file for editing.

    crontab -e -u icalgit

  2. Add the Cron Job: Add a cron job to pull the latest changes from your repository. It's advisable to use a passphraseless SSH key to avoid issues with cron executing in a non-interactive session.

    * * * * * cd /home/icalgit/icalgit/my-ical-files && GIT_SSH_COMMAND="ssh -i /home/icalgit/.ssh/id_icalgit_nopassphrase -o IdentitiesOnly=yes" git pull origin main

This cron job will run every minute, pulling the latest changes from the main branch of your repository. Adjust the schedule as needed.