Skip to content
isenePublic

About

Rust terminal calendar app. Feature clone of Timely with day/week/month views.

Topics

Resources

Stars

30 stars

Watchers

0 watching

Forks

Latest commit

 

History

98 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tock

The fast terminal calendar. Written in Rust.

Rust License Platform Stay Amazing

Terminal calendar with week view, event management, astronomy, and weather. Built on Crust. Feature clone of Timely rewritten in Rust for speed and single-binary distribution.

Tock screenshot

Features

  • 5-pane TUI: info bar, mini-month strip, week view grid, event details, status bar
  • Week view: 7-column layout with half-hour time slots, all-day event rows, weather per day; events that overlap sit side by side in lanes
  • Mini-month calendars: horizontal strip with event indicators, week numbers, today highlight
  • Calendar sources: Google Calendar (OAuth2), Outlook/365 (device auth), CalDAV (iCloud, Fastmail, Nextcloud, Radicale), local events
  • ICS import: parse and import .ics files with RRULE expansion for recurring events
  • Background sync: automatic polling with configurable intervals
  • Ephemeris engine: full planetary position calculator ported from ruby-ephemeris
    • Moon phase with emoji symbols, illumination percentage
    • Moon rise/set times
    • Sunrise/sunset times
    • Visible planets (Mercury, Venus, Mars, Jupiter, Saturn) with rise/set
    • Solstices, equinoxes, 11 meteor shower peaks
  • Weather: 7-day forecast from Met.no (free, no API key)
  • Desktop notifications: configurable alarms via notify-send
  • Event management: create, edit, delete, accept invites (RSVP). A change on a Google, Outlook or CalDAV calendar goes to its server
  • Guests: type addresses, comma-separated. Under gluon a name works too: it is looked up in kastrup's aliases and mail, and several matches are offered by number
  • Find: / lists every event with the typed words in its title, place or description
  • Agenda: L lists the coming 30 days; Enter goes to the picked event
  • Agenda in the shell: tock --agenda [DAYS] prints the next 30 days (or DAYS), one event a line, ids included. It reads the store without taking it, so it works while tock or gluon runs
  • Preferences: 15 configurable settings with inline color picker (256-color grid)
  • Calendar manager: enable/disable calendars, change colors, remove
  • Kastrup integration: reply to events via Kastrup (r key), jump to Kastrup (Z key)
  • Database: ferrite in ~/.tock/tock.ferrite/
  • New build notice: once a new build replaces the program, the version in the status bar turns orange and reads "is old: restart"

Install

Download the prebuilt binary from Releases, or build from source:

cargo build --release
cp target/release/tock ~/.local/bin/

Key Bindings

Key Action
d/RIGHT, D/LEFT Next/prev day
w/W Next/prev week
m/M Next/prev month
y/Y Next/prev year
UP/DOWN Navigate time slots
PgUp/PgDn Jump 10 slots
HOME/END Top/bottom of day
j/k Cycle events on day
e/E Jump to next/prev event
t Go to today
g Go to date
/ Find events by words; Enter goes to the picked one
L List the coming 30 days
n New event
Enter Edit event
I The guests alone: invite, take off
x/DEL Delete event
v View event details
a Accept invite (RSVP)
J Join the meeting: runs meeting_before from the config first, if set
Ctrl+Y Copy event to clipboard
Ctrl+A A Claude session about the screen and the seven days from the selected one (claude on the PATH); /exit comes back
i Import ICS file
G Setup Google Calendar
K Setup CalDAV (iCloud, Fastmail, Nextcloud, …)
O Sign in to Outlook/365: opens the sign-in page in your browser with the code on the clipboard
S Manual sync
C Calendar manager
P Preferences
Ctrl+R Clear caches
Ctrl+L Redraw
? Help
q Quit

Configuration

Config file: ~/.tock/config.yml

Settings include location (for astronomy/weather), work hours, calendar colors, sync intervals, and notification preferences.

tock keeps its calendars in ferrite, the Fe₂O₃ database that keeps its tables in memory. Every commit is forced to the disk before it returns.

Only one program may open the database, so tock also writes ~/.tock/calendars for other programs: one calendar that is on per line, with its number, its kind and its name, split by tabs.

Coming from a tock older than 0.1.47, which used SQLite? Run tock 0.1.53 once first. It copies tock.db into ~/.tock/tock.ferrite/; tock 0.2.0 no longer reads SQLite.

Google Calendar

Google wants an OAuth client of your own, made once in Google Cloud Console:

  1. Make a project, enable the Google Calendar API, and fill in the OAuth consent screen. While it is in "Testing", add yourself as a test user.
  2. Under Credentials, create an OAuth client ID of the type Desktop app and download its JSON file.

Then press G in tock and give your Google email. tock offers the newest client_secret_*.json in your download folder; Enter takes it, and a copy goes into ~/.config/tock/credentials (set by google.safe_dir), readable by you alone. The browser opens on Google's sign-in. Allow tock, and the page comes back to tock on a local port; nothing is pasted.

Every calendar of the account is added. The main one is on and syncs at once; C turns on the others.

Google mails the guests when you make or change an event of your own. An imported .ics or someone else's meeting goes up without mail.

A web-type client works too. If it lists a return address on this machine (http://localhost:8080/, say), tock listens there. If it lists one elsewhere, tock asks you to paste the address the browser ends on, or just the code.

A client still in "Testing" gets a sign-in that lapses after a week. Press G again with the same email: tock signs in anew and leaves the calendars as they are. Publishing the consent screen ends the weekly sign-in.

CalDAV: iCloud, Fastmail, Nextcloud and more

Press K and give the server, your user name and a password:

Service Server User name Password
iCloud https://caldav.icloud.com your Apple ID an app-specific password from account.apple.com
Fastmail https://caldav.fastmail.com your address an app password
Nextcloud https://<your server>/remote.php/dav your user your password or an app password
Radicale http://<host>:5232 your user your password

tock finds the account's calendars and adds every one that takes events, all on; C turns any off. A task list is left out. The password is kept in a file only you can read, beside the Google credentials.

Events come down with the rest of the sync. tock first asks the server whether a calendar changed at all, and fetches its events only when it has, or once a day. A repeating event arrives as its dates, each its own row.

Events you make or change in tock go up to the server, and so do the ones dropped into ~/.tock/incoming/. One date of a repeating series is changed on the server, not in tock. If the password changes, press K again with the same server and user.

Outlook needs none of this: O runs the whole device-code flow. A company sign-in policy can expire that sign-in after some weeks; tock then shows a red ⚠ line in the status bar and S says which calendar it is. Press O and sign in again; the calendar and its events stay as they are.

An event you make, edit or delete on an Outlook calendar goes to Outlook.

  • Outlook mails the invitation to every guest at once, and a cancellation when you delete a meeting you made.
  • tock asks whether a new event is a Teams meeting. teams: true under outlook: in the config makes yes the answer Enter gives.
  • An edit sends the title, the time, the place and the guests. The description stays as Outlook has it, since it carries the Teams link.
  • A guest list you empty is not sent; take the last guest off in Outlook.
  • An imported .ics goes up without its guests, so nobody gets mail for a meeting that was not yours to call.

Dependencies

Runtime: nothing beyond the binary; ferrite is built in. Optional: notify-send (notifications), xclip (clipboard).

Part of the Rust Terminal Suite

See the Fe₂O₃ suite overview and the landing page for the full list of projects.

Tool Clones Description
rush rsh Shell
crust rcurses TUI library
kastrup Heathrow Messaging hub
tock Timely Calendar
pointer RTFM File manager
scroll brrowser Web browser
crush - Rush config helper

License

Unlicense - public domain.

Credits

Created by Geir Isene (https://isene.org) with extensive pair-programming with Claude Code.

About

Rust terminal calendar app. Feature clone of Timely with day/week/month views.

Topics

Resources

Stars

30 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages