schedule
Set up an automated daily run of work-summary run --no-edit.
work-summary schedule [options]
Flags
| Flag | Type | Default | Description |
|---|---|---|---|
--time <HH:MM> | string | 08:00 | Time of day to run the report, in 24-hour format. |
--remove | flag | — | Remove the scheduled job. |
macOS (LaunchAgent)
On macOS, schedule writes a LaunchAgent plist to:
~/Library/LaunchAgents/com.work-summary.plist
# Schedule at 08:30 every day
work-summary schedule --time 08:30
Output:
LaunchAgent written to: ~/Library/LaunchAgents/com.work-summary.plist
Scheduled: work-summary run --no-edit at 08:30 every day
To activate, run:
launchctl load "~/Library/LaunchAgents/com.work-summary.plist"
To remove later:
work-summary schedule --remove
After running launchctl load, the job activates immediately and will fire every day at the configured time.
Logs
Output is written to:
~/.work-summary/logs/work-summary.log
~/.work-summary/logs/work-summary-error.log
Removing the job
work-summary schedule --remove
This unloads the LaunchAgent and deletes the plist.
Linux / other (crontab)
On non-macOS systems, schedule prints a crontab line for you to add manually:
work-summary schedule --time 08:00
Output:
Add this line to your crontab (run `crontab -e`):
0 8 * * * /usr/local/bin/work-summary run --no-edit >> ~/.work-summary/logs/work-summary.log 2>&1
To remove, run `crontab -e` and delete that line.
To remove:
crontab -e
# delete the work-summary line, save and exit
Notes
- The scheduled command always runs with
--no-edit(non-interactive). The report is written to~/.work-summary/reports/silently. - The binary path is auto-detected from
which work-summary. If detection fails, it falls back to the Node executable directory. - The scheduled run picks up configuration from
~/.work-summary/.envand~/.work-summary/config.json, so make sure your global setup is correct:work-summary doctor.