Skip to content

ical2jcal User Guide

This document enables you to convert iCalendar to jCalendar and vice versa, using the commands ical2jcal and jcal2ical on the command line.

Installation

ical2jcal is available on PyPI. It is compatible with Python 3.10 and later.

You have several options to install this tool.

pip comes with Python. To install this tool, run:

python -m pip install ical2jcal

After you have installed pipx, run:

pipx install ical2jcal

The development guide provides instructions on how to install ical2jcal using uv.

Convert .ics to JSON

iCalendar files have the .ics extension. You can convert them to an RFC 7265 compatible JSON using the ical2jcal command. We recommend using the .jcal extension for compatible JSON files.

The example below converts the example.ics file to example.jcal:

ical2jcal example.ics example.jcal

For more options, view the command line reference.

Convert JSON to .ics

RFC 7265 compatible JSON files can be converted with the jcal2ical command.

The example below converts the example.jcal file to example.ics:

jcal2ical example.jcal example.ics

For more options, view the command line reference.