Skip to content

AGENTS.md

Latest commit

 

History

History
33 lines (23 loc) · 1.09 KB

AGENTS.md

File metadata and controls

33 lines (23 loc) · 1.09 KB

AGENTS.md

This file contains instructions for AI agents working on this project.

Project Structure

  • notificator.js - Main plugin implementation
  • notificator.jsonc - Plugin configuration file
  • notificator-sounds/ - Directory containing sound files
  • package.json - Node.js package configuration
  • README.md - User documentation

Development Guidelines

  • This is a simple OpenCode plugin that uses the @opencode-ai/plugin package
  • The plugin exports NotificationPlugin which is the entry point
  • It uses the $ function to execute shell commands for platform-specific notifications
  • All plugin files copied to OpenCode are prefixed with "notificator"

Testing

To test the plugin:

  1. Ensure OpenCode is installed
  2. Copy notificator.js, notificator.jsonc, and notificator-sounds/ to your OpenCode plugins directory
  3. Trigger a generation or permission request in OpenCode
  4. Verify desktop notifications and sounds appear

Code Style

  • Use ES modules (export syntax)
  • Keep the plugin simple and focused
  • Support all three major platforms: macOS, Linux, and Windows