Agent Skills
› netalertx/NetAlertX
› project-navigation
project-navigation
GitHub提供NetAlertX项目的代码结构、关键文件路径及配置位置参考，辅助开发者快速定位后端入口、前端文件、数据库及插件系统，适用于探索代码库或查找特定组件的场景。
Trigger Scenarios
探索项目代码结构
查找特定组件或文件路径
了解前后端架构与配置
Install
npx skills add netalertx/NetAlertX --skill project-navigation -g -y
SKILL.md
Frontmatter
{
"name": "project-navigation",
"description": "Reference for the NetAlertX codebase structure, key file paths, and configuration locations. Use this when exploring the codebase or looking for specific components like the backend entry point, frontend files, or database location."
}
Project Navigation
Key Paths
| Component | Path |
|---|---|
| Workspace root | /workspaces/NetAlertX |
| Backend entry | server/__main__.py |
| API server | server/api_server/api_server_start.py |
| Plugin system | server/plugin.py |
| Initialization | server/initialise.py |
| Frontend | front/ |
| Frontend JS | front/js/common.js |
| Frontend PHP | front/php/server/*.php |
| Plugins | server/plugins/ |
| Plugin template | server/plugins/__template |
| Database helpers | server/db/db_helper.py |
| Device model | server/models/device_instance.py |
| Messaging | server/messaging/ |
| Workflows | server/workflows/ |
Architecture
NetAlertX uses a frontend–backend architecture: the frontend runs on PHP + Nginx (see front/), the backend is implemented in Python (see server/), and scheduled tasks are managed by a supercronic scheduler.
Runtime Paths
| Data | Path |
|---|---|
| Config (runtime) | /data/config/app.conf |
| Config (default) | back/app.conf |
| Database | /data/db/app.db |
| API JSON cache | /tmp/api/*.json |
| Logs | /tmp/log/ |
| Plugin logs | /tmp/log/plugins/ |
Environment Variables
Use these instead of hardcoding paths:
NETALERTX_DBNETALERTX_LOGNETALERTX_CONFIGNETALERTX_DATANETALERTX_APP
Documentation
| Topic | Path |
|---|---|
| Plugin development | docs/PLUGINS_DEV.md |
| System settings | docs/SETTINGS_SYSTEM.md |
| API docs | docs/API_*.md |
| Debug guides | docs/DEBUG_*.md |
Version History
- 548d698 Current 2026-08-19 22:08
- 8aec57b 2026-07-24 22:14
