netalertx/netalertx-plugin-run-development
.github/skills/plugin-run-development/SKILL.md
Create and run NetAlertX plugins. Use this when asked to create plugin, run plugin, test plugin, plugin development, or execute plugin script.
$ install --global
skillsauthnpx skillsauth add netalertx/netalertx netalertx-plugin-run-developmentInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 9, 2026, 2:41 AM5.4s1 file scanned
SKILL.md
- name:
- netalertx-plugin-run-development
- description:
- Create and run NetAlertX plugins. Use this when asked to create plugin, run plugin, test plugin, plugin development, or execute plugin script.
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.
Related Skills
netalertx/netalertx-settings-management
tools
VerifiedTrustedCommunity
Manage NetAlertX configuration settings. Use this when asked to add setting, read config, get_setting_value, ccd, or configure options.
5,989SKILL.mdUpdated Apr 9, 2026
netalertx/netalertx-sample-data
development
VerifiedTrustedCommunity
Load synthetic device data into the devcontainer. Use this when asked to load sample devices, seed data, import test devices, populate database, or generate test data.
5,989SKILL.mdUpdated Apr 9, 2026
netalertx/netalertx-docker-prune
devops
VerifiedTrustedCommunity
Clean up unused Docker resources. Use this when asked to prune docker, clean docker, remove unused images, free disk space, or docker cleanup. DANGEROUS operation. Requires human confirmation.
5,989SKILL.mdUpdated Apr 9, 2026
netalertx/netalertx-docker-build
development
VerifiedTrustedCommunity
Build Docker images for testing or production. Use this when asked to build container, build image, docker build, build test image, or launch production container.
5,989SKILL.mdUpdated Apr 9, 2026