Skip to main content

Lightweight cross-platform reminder daemon for developers

Project description

kim — keep in mind 🧠

Lightweight cross-platform reminder daemon for developers.
No UI. Config-driven. Runs in the background.

Documentation: https://pratikwayal01.github.io/kim/

kim demo


Install

Linux / macOS

curl -fsSL https://raw.githubusercontent.com/pratikwayal01/kim/main/install.sh | bash

Windows (PowerShell — installs, fixes PATH, sets up autostart)

powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/pratikwayal01/kim/main/install.ps1 | iex"

pip (all platforms — PATH must be configured manually on Windows, see below)

pip install --break-system-packages kim-reminder

PyPI

Windows + pip: After pip install, run this once to add kim to your PATH:

$p = python -c "import sysconfig; print(sysconfig.get_path('scripts','nt_user'))"
[Environment]::SetEnvironmentVariable("PATH",$env:PATH+";"+$p,"User")
$env:PATH += ";$p"

Then kim --version should work. Open a new terminal for the change to persist.

That's it. kim starts automatically on login.


Usage

kim start          Start the daemon
kim stop           Stop the daemon
kim status         Show running reminders
kim list           List all reminders from config
kim logs           Tail the log file
kim edit           Open config in $EDITOR
kim add            Add a new reminder
kim remove         Remove a reminder
kim enable         Enable a reminder
kim disable        Disable a reminder
kim update         Update a reminder
kim remind         Fire a one-shot reminder after a delay or at a time
kim interactive    Enter interactive mode (-i)
kim self-update    Check for and install updates
kim uninstall      Uninstall kim completely
kim export         Export reminders to file
kim import         Import reminders from file
kim validate       Validate config file
kim slack          Slack notification settings
kim completion     Generate shell completions
kim sound                          # show current config + format notes
kim sound --set ~/sounds/bell.mp3  # set custom file (validates on set)
kim sound --clear                  # revert to system default
kim sound --test                   # play it immediately
kim sound --enable / --disable     # toggle sound on/off

Interval reminders

kim add "drink water" -I 30m          # every 30 minutes
kim add "drink water" --every 30m     # same — --every is an alias for -I
kim add "stretch" --every 1h

Daily at a fixed time

kim add standup --at 10:00                        # every day at 10:00 local time
kim add standup --at 10:00 --tz Asia/Kolkata      # with explicit timezone

One-shot reminders

# Relative
kim remind "standup call" in 10m
kim remind "take a break" in 1h
kim remind "check the oven" in 25m
kim remind "deploy window opens" in 2h 30m

# Absolute — fire at a specific time
kim remind "standup" at 10:00
kim remind "standup" at tomorrow 9am
kim remind "call" at friday 2pm
kim remind "deploy" at 2026-04-07 14:30 --tz America/New_York

# Urgency (default: normal)
kim remind "wake up!" in 5m --urgency critical

Fires once, runs in the background, frees your terminal immediately.

Persistent — one-shot reminders survive daemon restarts and system reboots. Stored in ~/.kim/oneshots.json and loaded automatically when the daemon starts. Expired reminders are cleaned up on next startup.


Config — ~/.kim/config.json

{
  "reminders": [
    {
      "name": "eye-break",
      "interval": "30m",
      "title": "👁️ Eye Break",
      "message": "Look 20 feet away for 20 seconds. Blink slowly.",
      "urgency": "critical",
      "enabled": true
    },
    {
      "name": "water",
      "interval": "1h",
      "title": "💧 Drink Water",
      "message": "Stay hydrated.",
      "urgency": "normal",
      "enabled": true
    }
  ],
  "sound": true
}
Field Values Description
name string Unique identifier
interval number or string ("30m", "1h", "1d") How often to fire
title string Notification heading
message string Notification body
urgency low / normal / critical Notification priority
enabled true / false Toggle without deleting
sound true / false (top-level) Play sound globally
slack object (top-level) Slack settings

Per-Reminder Overrides

Each reminder can override global sound and Slack settings:

{
  "reminders": [
    {
      "name": "standup",
      "interval": "30m",
      "sound_file": "~/sounds/urgent.wav",
      "slack": {
        "enabled": true,
        "webhook_url": "https://hooks.slack.com/services/...",
        "channel": "#standup-alerts"
      }
    }
  ],
  "sound": true,
  "slack": {
    "enabled": true,
    "webhook_url": "https://hooks.slack.com/services/...",
    "channel": "#general"
  }
}

Or via CLI:

kim add standup -I 30m --sound-file ~/sounds/urgent.wav --slack-channel "#standup"

Slack Integration

{
  "reminders": [...],
  "sound": true,
  "slack": {
    "enabled": true,
    "webhook_url": "https://hooks.slack.com/services/your-webhook-id",
    "bot_token": "xoxb-your-bot-token",
    "channel": "#general"
  }
}

Use a Webhook or a Bot Token — not both. Test with kim slack --test.


How it works

Platform Autostart Notifications
Linux systemd user service notify-send
macOS launchd agent osascript
Windows Task Scheduler PowerShell toast
  • Pure Python stdlib — no pip installs
  • Zero config — works out of the box, creates default config on first run
  • All reminders run on a single heapq scheduler thread — memory stays flat (~0.02 MB) regardless of how many reminders you have
  • Logs at ~/.kim/kim.log, PID at ~/.kim/kim.pid

Why kim?

Tool Pure stdlib CLI-first Zero config One-shot Recurring Cross-platform Slack Config-driven Interactive Self-update Export/Import
kim
Remind ⚠️ ⚠️
Cron ⚠️ ⚠️ ⚠️
macOS Reminders
Google Calendar ⚠️

Uninstall

kim uninstall

Start small. Keep it in mind.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kim_reminder-4.5.4.tar.gz (76.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kim_reminder-4.5.4-py3-none-any.whl (57.1 kB view details)

Uploaded Python 3

File details

Details for the file kim_reminder-4.5.4.tar.gz.

File metadata

  • Download URL: kim_reminder-4.5.4.tar.gz
  • Upload date:
  • Size: 76.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kim_reminder-4.5.4.tar.gz
Algorithm Hash digest
SHA256 ba9f18e479ae9283b48e60465635fcdd28394cfb2ab51bc59f6d9febc106cee4
MD5 b13a2a37a0db20997d7711e97d747a47
BLAKE2b-256 3195223ab3873eec373e9340a602e4376362b6a641ab32d707c7612958474a65

See more details on using hashes here.

File details

Details for the file kim_reminder-4.5.4-py3-none-any.whl.

File metadata

  • Download URL: kim_reminder-4.5.4-py3-none-any.whl
  • Upload date:
  • Size: 57.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kim_reminder-4.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 90784f97fd961ac6380dd8172e43d7954797e3f112928522b132096767d451ef
MD5 65b99a3a3560849ca3bb51bcd8595b91
BLAKE2b-256 59f914b5dd1fa30d48d6bde494f1d250c1099ddc8ccd8314045ac0abd99cd08f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page