Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.94 KB

README.md

File metadata and controls

49 lines (30 loc) · 2.94 KB

aw-sync-suite-plugins

tests Latest release

🔍 About

This is a Repository that hosts the plugins of aw-sync-suite Agent.For versions of aw-sync-suite >= 0.1.3

Plugins of aw-sync-suite Agent are used to extend the functionality of the agent. The plugins are written in Go and are executed by the agent during the aggregation stage.

⚙️ Plugins

Plugin Description Has Config Config File
filters Filters the data of ActivityWatch ✅ aw-plugin-filtes.yaml

🛠️ How to create a plugin

Core Plugin Structure

To write a plugin, you need to create a Go folder in the plugins directory. Inside this folder you should contain the plugin implementation idea which will implements the Plugin interface as a core of the plugin.

Method Signature Description
Initialize Initialize() Initialization of the plugin (Before the aw data)
Execute Execute(watcher string, events Events, userID string, includeHostName bool) Execution of the plugin (While having the aw data)
ReplicateConfig ReplicateConfig(path string) Replicate the plugin config (for service purposes)
RawName RawName() string Get the raw name of the plugin (module name)
Name Name() string Get the name of the configuration of the plugin (with prefix aw-plugin-{RawName}.yaml

📝 License

This project is licensed under the MIT license.

See LICENSE for more information.