Overview
The node "Tmux Scheduler" allows scheduling and managing timed tasks within tmux terminal sessions. Specifically, the Create Reminder operation lets users set reminders that send a message to a specified tmux window at a scheduled time. This is useful for automating notifications or alerts inside terminal multiplexers, helping users keep track of important events or deadlines without leaving their terminal environment.
Practical examples include:
- Sending a reminder message to a developer's tmux session before a meeting.
- Scheduling alerts for system maintenance tasks.
- Automating check-ins or status updates in collaborative terminal sessions.
Properties
| Name | Meaning |
|---|---|
| Target Window | The tmux target window where the reminder message will be sent (e.g., session:window). |
| Reminder Message | The text content of the reminder message to send. |
| Reminder Time | The date and time when the reminder should be sent. If omitted, defaults to 30 minutes from now. |
Output
The output JSON object for the Create Reminder operation includes:
success(boolean): Indicates if the reminder was successfully created.reminderId(string): A unique identifier for the reminder.targetWindow(string): The tmux window targeted by the reminder.message(string): The reminder message text.scheduledTime(ISO string): The exact time when the reminder is scheduled to be sent.minutesUntil(number): Minutes from the current time until the reminder triggers.
If an error occurs, the output contains an error field with the error message.
The node does not output binary data.
Dependencies
- Requires access to a tmux environment where commands can be executed.
- Uses local filesystem
/tmp/tmux-reminders.jsonto store reminder metadata. - May require an API key credential for the orchestrator service (optional).
- Relies on external scripts or utilities such as
atcommand for scheduling jobs and possibly custom shell scripts. - Node uses child process execution (
execSync) to interact with system commands likeat.
Troubleshooting
- Reminder time must be in the future: The node validates that the scheduled reminder time is after the current time. Setting a past time will cause an error.
- Unable to schedule reminder: Could occur if the underlying scheduling command or script is missing or fails. Ensure the
atcommand is installed and accessible. - File system errors: The node reads/writes
/tmp/tmux-reminders.json. Permission issues or disk problems may cause failures. - Invalid target window: If the specified tmux target window does not exist or is incorrect, the reminder may fail to send.
- Credential issues: If configured to use an API key or external scripts directory, ensure credentials are valid and paths are correct.
To resolve errors:
- Verify the reminder time is correctly set in the future.
- Confirm the tmux session and window names are accurate.
- Check system availability of required commands (
at, shell scripts). - Inspect permissions for reading/writing the reminders file.
- Review any provided error messages for specific failure points.