Netalertx Plugin Run Development
Developmentnetalertx-plugin-run-developmentNetalertx Plugin Run Development is an Agent Skill for development published in the netalertx/NetAlertX repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Create and run NetAlertX plugins. Use this when asked to create plugin, run plugin, test plugin, plugin development, or execute plugin script.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/netalertx/NetAlertX/blob/HEAD/.github/skills/plugin-run-development/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/netalertx-plugin-run-development, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Plugin Development
Expected Workflow for Running Plugins
- Read this skill document for context and instructions.
- Find the plugin in
front/plugins/<code_name>/. - Read the plugin's
config.jsonandscript.pyto understand its functionality and settings. - Formulate and run the command:
python3 front/plugins/<code_name>/script.py. - Retrieve the result from the plugin log folder (
/tmp/log/plugins/last_result.<PREF>.log) quickly, as the backend may delete it after processing.
Run a Plugin Manually
python3 front/plugins/<code_name>/script.py
Ensure sys.path includes /app/front/plugins and /app/server (as in the template).
Plugin Structure
front/plugins/<code_name>/
├── config.json # Manifest with settings
├── script.py # Main script
└── ...
Manifest Location
front/plugins/<code_name>/config.json
code_name== folder nameunique_prefixdrives settings and filenames (e.g.,ARPSCAN)
Settings Pattern
<PREF>_RUN: execution phase<PREF>_RUN_SCHD: cron-like schedule<PREF>_CMD: script path<PREF>_RUN_TIMEOUT: timeout in seconds<PREF>_WATCH: columns to watch for changes
Data Contract
Scripts write to /tmp/log/plugins/last_result.<PREF>.log
Important: The backend will almost immediately process this result file and delete it after ingestion. If you need to inspect the output, run the plugin and immediately retrieve the result file before the backend processes it.
Use front/plugins/plugin_helper.py:
from plugin_helper import Plugin_Objects
plugin_objects = Plugin_Objects()
plugin_objects.add_object(...) # During processing
plugin_objects.write_result_file() # Exactly once at end
Execution Phases
once: runs once at startupschedule: runs on cron schedulealways_after_scan: runs after every scanbefore_name_updates: runs before name resolutionon_new_device: runs when new device detectedon_notification: runs when notification triggered
Plugin Formats
| Format | Purpose | Runs |
|---|---|---|
| publisher | Send notifications | on_notification |
| dev scanner | Create/manage devices | schedule |
| name discovery | Discover device names | before_name_updates |
| importer | Import from services | schedule |
| system | Core functionality | schedule |
Starting Point
Copy from front/plugins/__template and customize.