RustCal

Terminal based calendar/agenda app written in rust

Built with Cursive

pictured above: version 0.2

Features

• Month overview
• Basic Todo List functionality
• Completly terminal based UI
• Flexible cross-platform TUI library that supports Linux, Windows and Mac
• Simple saving functionality through a single json file (press 'k' to save)
• A realtime clock
• Pomodoro Timer
• completely offline

Future Goals

• Custom UI theme (dark mode)
• Settings menu
• Better todo editing

Building the project

• Available backends

  • ncurses-backend (default): uses the [ncurses-rs] library directly. Currently only compatible on Linux and macOS.
  • pancurses-backend: uses the [pancurses] library, which forwards calls to [ncurses-rs] on Linux/macOS or [pdcurses-sys] on Windows.
  • termion-backend: uses the pure-rust [termion] library. Works on Linux, macOS, and Redox.
  • crossterm-backend: uses the pure-rust [crossterm] library. Works crossplatform, even for windows systems down to version 7.
  • blt-backend: uses the cross-platform [BearLibTerminal.rs] binding. Works on Linux and Windows.

• Instructions

  1. clone the git repository
  2. modify the toml file line pictured below with the backend you desire

  version = "0.14"
  default-features = false
  features = ["<Your backend here>"]
  

  3. use the command cargo run to launch the application

User Manual

• Left click on mouse can be used to click on all buttons
• Right click on mouse opens up todo list at the date clicked
• Arrow keys are used to navigate without mouse
• Tab cycles through all buttons
• Enter opens todo list at selected day
• K saves the state to a json file
• Date in the top left corner navigates to current day in calendar when clicked
• wasd can be used to move around the current focused window

app running in vs code terminal: