Installation

This guide details how to install and configure Schedule Management on your system.

Compatibility Note: This tool is currently optimized for macOS (via launchd) and Linux. Windows support is on the roadmap.

Prerequisites

Before proceeding, ensure you have the following installed:

• Python 3.12+: Download Python
• Git: Download Git
• Terminal: Any standard terminal emulator (Terminal.app, iTerm2, etc.)
• OpenCode CLI: Required for rmd setup and rmd sync
• Node.js and Rust: Required only when running or building the optional Tauri desktop app from source

Installation Methods

We provide an automated installer for convenience, but manual installation is fully supported for users who prefer granular control.

Method 1: Automated Installer (Recommended)

The install.sh script handles dependency installation, configuration scaffolding, and service registration in one go. It installs rmd as the primary CLI and keeps reminder as a compatibility alias.

1. Clone the repository:

   git clone https://github.com/sergiudm/schedule-everything.git
   cd schedule-everything

2. Run the installer:

   ./install.sh

   The script will:

   • Install the Python package and dependencies.
   • Create the ~/schedule_management directory structure.
   • Ensure required config files exist.
   • Prompt for missing required config values one by one.
   • Register the background service (on macOS).

3. Install OpenCode CLI:

   ./third_party/opencode/install --no-modify-path

4. Finalize Setup: Follow the on-screen instructions to load the service. Typically, this involves:

   launchctl load ~/Library/LaunchAgents/com.sergiudm.schedule_management.plist

Method 2: Manual Installation

For advanced users or those integrating into existing environments.

1. Clone the repository:

   git clone https://github.com/sergiudm/schedule_management.git
   cd schedule_management

2. Install the Package: We recommend installing in editable mode (-e) to easily pull updates.

   uv pip install -e .

   Tip: Consider using a virtual environment managed by uv or venv.

3. Install OpenCode CLI if you want the AI-assisted commands:

   ./third_party/opencode/install --no-modify-path

4. Create Configuration Directory:

   mkdir -p ~/schedule_management/config/user_config_0

5. Initialize Config Files: Copy the templates into the first versioned config set:

   cp config/settings_template.toml ~/schedule_management/config/user_config_0/settings.toml
   cp config/week_schedule_template.toml ~/schedule_management/config/user_config_0/odd_weeks.toml
   cp config/week_schedule_template.toml ~/schedule_management/config/user_config_0/even_weeks.toml

6. Configure Shell Environment: Add the following to your shell profile (~/.zshrc, ~/.bash_profile, etc.) to access the rmd CLI:

   export PATH="$HOME/schedule_management:$PATH"
   export REMINDER_CONFIG_DIR="$HOME/schedule_management/config"
   alias rmd="$HOME/schedule_management/rmd"

7. Apply Changes:

   source ~/.zshrc  # or your specific profile file

Method 3: PyPI Installation

Note: This method installs the library code but requires manual configuration setup.

pip install schedule-management

After installation, follow steps 3-6 from the "Manual Installation" section above.

Optional macOS Desktop App

The source tree includes a Tauri 2 desktop app named Schedule Everything. It is a daily command center for the same local files used by the CLI: tasks, deadlines, habits, today's schedule, and accepted sync overlays.

From the repository root:

npm install
npm run tauri:dev

To create standalone macOS bundles:

npm run tauri:build

The build command first packages schedule-gui-bridge as a Python sidecar, then runs the Tauri release build. Outputs are written to:

src-tauri/target/release/bundle/macos/Schedule Everything.app
src-tauri/target/release/bundle/dmg/Schedule Everything_0.1.0_<arch>.dmg

Verifying Installation

Confirm that everything is working correctly.

1. Check CLI:

   rmd --help

   Expected output: A list of available commands.

2. Check Service Status (macOS):

   launchctl list | grep schedule

   Expected output: A process ID and status code (usually 0).

3. View Schedule:

   rmd status

   Expected output: A summary of upcoming events or "No upcoming events".

Uninstallation

To completely remove the application:

1. Unload the Service:

   launchctl unload ~/Library/LaunchAgents/com.sergiudm.schedule_management.plist

2. Remove Configuration & Data:

   rm -rf "$HOME/schedule_management"

3. Remove Python Package:

   pip uninstall schedule-management

Troubleshooting

• "Command not found: rmd": Ensure you have added the alias and exports to your shell profile and sourced it.
• Service not starting: Check the logs (standard error/output) or try running rmd update to refresh the service definition.