dLine

dLine is a simple and powerful command-line tool that brings your calendar directly to your terminal. You can track important dates, add events quickly using APIs, calculate timespans, and manage multiple calendars—all without leaving your terminal.

Designed for developers, dLine makes managing your schedule smooth and efficient.

Features

• Dynamic View: Run dline without arguments to see the current month’s events at a glance. Past dates are shaded, future events are highlighted, and color-coded categories make it easy to navigate. You can even filter out categories for a cleaner view.

• Static View: Use dline -m yyyy/mm to display a simple monthly calendar for any given month. Great for when you just need a clear snapshot without additional details.

• Event Calculator View: Need to count workdays between two dates? dline -w start_date end_date does it for you, categorizing weekdays and weekends automatically.

• Administration: Easily manage your calendar datasets with dline -b. Add, delete, update, and clean your data as needed. Switching between multiple calendars or importing public holidays is simple. There's even a way to terminate all reminder processes.

On the first launch, dLine will ask for your region to fetch relevant holidays. Don't worry — you can change this later if needed.

Introduction on YouTube:

Screenshots

Dynamic View

Static View

Event Calculator View

Admin

Documentation

Usage:
 dline -a                                                     Add event (interactive mode)
 dline -a 2024/04/17 3 "11:30 Lunch with Lucy"                Add event directly
 dline                                                        Show current month calendar

Options:
 -a, --add [yyyy/mm/dd] [x] [desc]                            Add event. No args invokes interactive mode
 -b, --base                                                   Manage your data, as snapshots of your changes
                                                              (file management)
 -c, --clean                                                  Remove old entries
 -d, --delete [GCA|OHA|pattern]                               Delete imported calendars, or local matching entries.
 -e, --export                                                 Export calendar to TSV format
 -f, --filter [x] [x] ...                                     Toggle visibility of one or more categories
 -h, --help                                                   Show help
 -i, --import [TSV|GCA|OHA]                                   Import events from external sources
 -k, --kill                                                   Terminate pending reminders
 -l, --legend                                                 Toggle legend display
 -m, --month [yyyy/mm]                                        Show monthly calendar
 -o, --open                                                   Open data file in terminal editor
 -p, --print-details                                          Toggle calendar details
 -r, --resolve                                                Interactive dialogue to resolve deadlines
 -s, --school [0|1]                                           Set school holidays as work days (0) or holidays (1)
 -t, --test [yyyy/mm/dd]                                      Set "today" for testing
 -u, --update [GCA|OHA] | [pattern] [yyyy/mm/dd] [x] [desc]   Update from APIs or local matching entries
 -v, --version                                                Show version
 -w, --workdays [start_date] [end_date]                       Calculate workdays from optional start_date
                                                              (default: today) to end_date
 -x, --xdg-open                                               Open data file in GUI editor

Event categories [x]:
  1: Deadline
  2: Work
  3: Personal
  4: Birthday & Anniversary
  5: Public Holiday
  6: Vacation
  7: Sick Leave
  8: School Holiday

Default View:

1. Automated Processes:

• The Dynamic View operates autonomously, continuously monitoring your calendar data.
• It doesn’t require explicit user input; hence, the name “Dynamic.”

2. Countdown to Deadlines:

• The background processes diligently search for the most relevant deadlines.
• It looks ahead into the foreseeable future, spanning up to 6 months or until the end of the current year (whichever is further), scanning for unresolved deadlines.
• Additionally, it scans the relevant past, reaching up to 1 month ago, searching for overdue deadlines.
• The goal? To present you with a countdown to the nearest most important unresolved event.

3. Foreseeable Events:

• Beyond deadlines, the Dynamic View also identifies other crucial events.
• It anticipates events that require your attention within a specific timeframe—up to 48 hours ahead.
• If such events exist, it creates a time trigger for pop-up notifications.
• Even if you restart your PC, these countdowns persist, thanks to the at command.

4. Maintenance and Updates:

• The Dynamic View handles routine maintenance tasks.
• Cleanups: Removing outdated or irrelevant data.

5. Automatic Updates: Fetching fresh calendar events from APIs.

• You can configure the timing and frequency of these processes through the .dlinerc file.
• User translations and custom color schemes are also supported, ensuring a personalized experience.

In summary, the Dynamic View is your new default, proactive calendar companion, silently managing deadlines, events, and data hygiene.

Categories Filtration:

Use dline -f and input the category codes you wish to view or hide (e.g. dline -f 4 6 8). This feature simplifies your calendar, allowing you to focus on the categories that matter most to you at any given time.

Config Files:

• .dlinerc: system-wide settings like user translations, color themes, cleanup frequencies
• settings.json: calendar-specific preferences

Data File:

• events_data.txt: Default data file, but upon creation of a new calendar, a file with a prefix is added. It's possible to switch between the existing calendars by dline -b > Select.

Installation

Required Dependencies:

Before the first run, make sure you have:

https://salsa.debian.org/debian/at
https://github.com/jqlang/jq

Optional Dependencies (recommended):

https://github.com/insanum/gcalcli
https://github.com/junegunn/fzf
https://github.com/pyrho/hack-font-ligature-nerd-font

With the right setup, dLine could integrate with your Google Calendar. By aligning your calendar categories with dLine's system, you can import events directly, making your schedule accessible locally or via Google Calendar, according to your preference. Important resolution of a relevant issue.

Credits:

Holiday data based on OpenHolidays API

Minimum Requirements:

Bash Version: dLine requires Bash 4.0 or newer. Older versions (e.g., Bash 3.x on macOS) will not work correctly due to unsupported features like associative arrays.

• To update Bash on macOS: Use Homebrew (brew install bash).

Holiday Data and Google Calendar Integration:

If OpenHolidaysAPI doesn't support your country, you can still integrate holidays by:

1. Creating a separate Google Calendar for public holidays in your region.

2. Running dline --import GCA to sync it with dLine.

3. Assigning the imported events to the “Public Holiday” category during the setup prompt.

This process works for School Holidays and other custom calendars too!

Filtering Events with fzf

When using dline -b, select "View" and choose a dataset. If fzf is installed, it will be triggered, allowing you to filter entries interactively. For example, you can filter all meetings in June this year labeled with #projectX easily using this feature.

Usage/Examples

dline -a 2024/07/04 3 Buy milk

• Adding a new event (yyyy/mm/dd x desc), where x is the category code, desc is an arbitrary description with a special case where the description may start with hh:mm time format (which will eventually trigger a scheduled reminder as a popup) and may end with any hashtag (e.g. #projectX) for easier event handling related to a single topic.

dline -d "#projectX"

• Deleting all events tagged with #projectX.

dline -f 4 6 8

• Toggling visibility of events with codes 4 (Birthday & Anniversary), 6 (Vacation) and 8 (School Holiday).

dline -i GCA

• Triggers an import of calendar(s) from Google Calendar in interractive mode. Read the docs from the project gcalcli first. The same operation will be triggered during the very first run, so you may want to run it again if you need to import a new calendar.

dline -s 1

• In case you're a student, run this to make sure your School Holidays are shown as days off, not as work days.

dline -s 0

• If you’re a parent, use this command to view School Holidays in your region as regular work days. It serves as a reminder to stay informed about when your kids will be off from school.

dline -m 2024/10

• Displaying a static monthly calendar, without triggering any automatic background process.

dline -w 2024/01/01 2024/12/31

• Once you’ve added all your calendars to dLine, you can utilize the command above to assess a specific timespan. It helps you determine the number of distinct event categories within your specified time range. This feature proves especially useful for freelancers who charge based on workdays—allowing them to calculate holidays, sick days, weekends, and workdays before providing quotes to their clients.

Appendix

Managing time effectively is key to productivity. dLine simplifies scheduling, so you can focus on what matters most.

Easter Egg Alert

Attention devs! There's a hidden Easter Egg in this project. If you find it, let us know and get featured in our "Hall of Fame". Happy coding! 🚀

Hall of Fame

James Cuzella (@trinitronx)