Cronos

A terminal calendar app built with OpenTUI.

https://github.com/user-attachments/assets/d26b4de6-23c7-4ac3-9147-4517389c3c5e

Some earlier versions previously written in Zig + Sokol

Usage

bun install
bun dev

Install (CLI + TUI)

Requires Bun on your PATH.

npm i -g @tuis/cronos
cronos

CLI

cronos list
cronos list --date 2025-04-10
cronos next
cronos add --date 2025-04-10 "Lunch 12pm-1pm #green"
cronos delete --id event-12-1713456789

Keyboard Shortcuts

Global (no modal open)

| Key | Action | |-----|--------| | [ / ] | Previous / Next month | | h / l | Previous / Next day | | k / j | Previous / Next week | | t | Jump to today | | y | Toggle year view | | v | Toggle agenda side view | | a | Add event | | s | Search events | | g | Go to date | | , | Settings | | q | Quit |

Agenda (when agenda is open)

| Key | Action | |-----|--------| | Up / Down | Navigate events | | e | Edit selected event | | d | Delete selected event | | v | Toggle agenda side view |

Add/Edit modal

| Key | Action | |-----|--------| | Enter | Save event | | Esc | Close |

Search modal

| Key | Action | |-----|--------| | Up / Down | Navigate results | | Enter | Go to date | | Ctrl+E | Edit selected event | | Ctrl+D | Delete selected event | | Esc | Close |

Go to date modal

| Key | Action | |-----|--------| | Tab / Shift+Tab | Next / Previous field | | Enter | Go to date | | Esc | Close |

Settings modal

| Key | Action | |-----|--------| | h / l | Previous / Next section | | j / k | Previous / Next option | | Tab / Shift+Tab | Focus next / previous area | | Enter | Activate | | Esc | Close |

Google Calendar Sync (preview)

Requires an OAuth client for an installed app.

export CRONOS_GOOGLE_CLIENT_ID="your-client-id"
# Optional when using PKCE, required if your client has a secret
export CRONOS_GOOGLE_CLIENT_SECRET="your-client-secret"

Open Settings (,) → Sync → Connect Google. Calendars map to colors, and events import as all-day entries for now.

Adding a Shortcut

This is the full flow for adding a new shortcut and its behavior end-to-end.

1. Add the command definition
   • Add a new entry in the relevant module under src/features/*/*Commands.ts.
   • Include id, title, keys, layers, and run.
2. Pick a layer
   • Use an existing layer (global, agenda, modal:add, modal:goto, modal:search, modal:settings) in layers.
   • If you need a new context, add a new layer in src/app/commands/keymap.ts.
3. Wire UI handlers (if needed)
   • For view-local behavior, register handlers in the component via set...CommandHandlers.
4. Update docs
   • Add bindings to the appropriate Keyboard Shortcuts section in this README.

Example (add n to jump to next year):

// src/features/calendar/calendarCommands.ts
export const calendarCommands = [
  // ...
  {
    id: "calendar.nextYear",
    title: "Next year",
    keys: ["n"],
    layers: ["global"],
    run: () => goToNextYear,
  },
];

Roadmap

• [ ] Help on '?'
• [ ] Settings modal on ','
  • [x] Week start day
  • [x] Notification options
  • [x] Themes
  • [x] Google Calendar sync
  • [ ] iCal export/import
• [ ] Notifications for upcoming events
• [ ] Recurring events
• [x] Open google meet links
• [x] cli support (cronos add ...)
• [x] Persistent storage
• [x] Search through event list
• [x] Agenda side view
• [x] Yearly view