Repository navigation
Feature Request: Plugin shutdown hook for graceful cleanup #10524
Description
Summary
Add a shutdown/exit hook to the plugin system so plugins can perform cleanup operations before OpenCode exits.
Use Case
I'm developing opencode-sync, a plugin that syncs OpenCode data (sessions, messages, config, etc.) to a private GitHub repository.
The plugin needs to sync local changes to remote before exit to prevent data loss. Currently, there's no way for plugins to:
- Know when OpenCode is about to exit
- Perform async cleanup operations before process termination
Current Behavior
Looking at the source:
packages/plugin/src/index.ts- TheHooksinterface only haseventhook for Bus eventspackages/opencode/src/cli/cmd/tui/thread.ts- HasonExitcallback but it's internal, not exposed to plugins- Session events are
Created,Updated,Deleted,Diff,Error- no shutdown event
When OpenCode exits (Ctrl+C, :q, etc.), plugins have no opportunity to run cleanup code.
Proposed Solution
Add a shutdown hook to the plugin Hooks interface:
export interface Hooks {
event?(input: { event: Bus.Event }): void;
shutdown?(): Promise<void>; // New hook
}The shutdown hook should:
- Be called before OpenCode terminates
- Support async operations (return Promise)
- Have a reasonable timeout (e.g., 5 seconds) to prevent hanging
Alternatives Considered
- Node.js process events (
beforeExit,SIGINT,SIGTERM) - OpenCode intercepts signals before plugin handlers run - Frequent background syncing - Works but can't guarantee final changes are synced
- File watching with debounce - Same limitation, final changes may be lost
Additional Context
This would enable plugins to:
- Sync data to remote storage
- Close database connections
- Flush logs
- Clean up temporary files
- Save state
Thank you for considering this feature!
Metadata
Metadata
Assignees
Labels
No labels
Activity
github-actions commentedon Jan 25, 2026
This issue might be a duplicate of existing issues. Please check:
Feel free to ignore if none of these address your specific case.
feat(plugin): add shutdown hook
RKelln commentedon Mar 9, 2026
I use beads (https://github.com/anomalyco/beads) for issue tracking, which embeds a Dolt SQL server for its local database. Beads 0.59+ manages the Dolt server lifecycle automatically (auto-start on first bd command, stop via bd dolt stop).
When OpenCode exits — even a normal Ctrl+C or :q — I'd like to stop the dolt server.
This affects anyone using OpenCode with an embedded database (Dolt, SQLite WAL, etc.) that requires graceful shutdown for data integrity.
Added (Opus written) PR for this:
RKelln:feat/plugin-shutdown-hook
andrewstackme commentedon May 1, 2026
what is the timeline for resolution?
jtackaberry commentedon May 14, 2026
Running into this as well just building a small custom plugin to improve tmux integration. I need to be able to clear some tmux pane/window variables on exit. I'm resorting to a tragic hack at the moment (which only happens to work because cleanup activities can be done outside of opencode), so a proper shutdown hook would be very much appreciated.
rekram1-node commentedon Jun 8, 2026
There is an instance dispose hook now