A terminal-based reminder application.
The application has been refactored to follow the standard Go project structure:
remi/
├── cmd/
│ └── remi/ # Main application entry point
│ └── main.go
├── internal/ # Application-specific packages
│ ├── app/ # Main application logic
│ ├── config/ # Configuration handling
│ ├── freeze/ # Freeze mode functionality
│ ├── model/ # Business logic and application state
│ └── ui/ # Terminal user interface
├── pkg/ # Reusable packages
│ └── timer/ # Countdown timer functionality
└── remi.yaml # Configuration file
- Multiple configurable reminders
- Terminal-based user interface
- Start, pause, and reset timers
- Dialog-based freeze mode to enforce breaks (macOS only)
The application is configured via the remi.yaml file. The configuration file is loaded in the following order:
- First, it tries to load from the home directory (
~/remi.yaml) - If not found in the home directory, it falls back to the current directory
Example configuration:
config:
# Application-wide settings
# Currently no global settings are used
events:
- name: "Drink water"
interval: "30m"
notify: true # Legacy option, kept for backward compatibility
autoStart: true # Optional, defaults to true if not specified
freeze: "1m" # Optional, shows dialog for 1 minute when timer completes
- name: "Stand up and walk around"
interval: "1h"
notify: true # Legacy option, kept for backward compatibility
autoStart: false # Optional, set to false to start in paused state
freeze: "5m" # Optional, shows dialog for 5 minutes when timer completesThe freeze option allows you to enforce breaks by displaying a blocking dialog when a timer completes:
- When a timer with
freezeset completes, a macOS dialog appears for the specified duration - During the freeze period, the timer shows "⏸ Freezing (MM:SS)" with a countdown of the remaining time
- You cannot control (start/pause/reset) a timer while it's in freeze mode
- After the freeze period ends, the timer automatically starts the next round
This is useful for enforcing breaks and preventing you from immediately dismissing reminders.
s <index>- Start/resume a timerp <index>- Pause a timere <index>- End/reset a timer
go run cmd/remi/main.goOr build and run:
go build -o remi cmd/remi/main.go
./remiThe refactored code follows these design principles:
- Separation of Concerns: Each package has a specific responsibility
- Dependency Injection: Components are created and passed where needed
- Interface-Based Design: Using interfaces for better testability
- Error Handling: Improved error handling throughout the application
- Scalability: Structure makes it easier to add new features