Agent Skills › netalertx/NetAlertX › about-netalertx-project-structure

about-netalertx-project-structure

GitHub

提供 NetAlertX 项目的代码结构导航，包括关键路径、前后端架构说明、运行时配置及文档索引。用于帮助用户快速定位文件位置和理解项目布局。

.github/skills/project-navigation/SKILL.md netalertx/NetAlertX

Trigger Scenarios

询问文件位置了解项目结构查找特定模块代码查询关键路径

Install

npx skills add netalertx/NetAlertX --skill about-netalertx-project-structure -g -y

More Options

Non-standard path

npx skills add https://github.com/netalertx/NetAlertX/tree/main/.github/skills/project-navigation -g -y

Use without installing

npx skills use netalertx/NetAlertX@about-netalertx-project-structure

指定 Agent (Claude Code)

npx skills add netalertx/NetAlertX --skill about-netalertx-project-structure -a claude-code -g -y

安装 repo 全部 skill

npx skills add netalertx/NetAlertX --all -g -y

预览 repo 内 skill

npx skills add netalertx/NetAlertX --list

SKILL.md

Frontmatter

{
    "name": "about-netalertx-project-structure",
    "description": "Navigate the NetAlertX codebase structure. Use this when asked about file locations, project structure, where to find code, or key paths."
}

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 that runs periodic jobs.

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/`