Agent Skills › netalertx/NetAlertX › project-navigation

project-navigation

GitHub

提供NetAlertX代码库结构、关键文件路径及配置位置参考，用于快速定位后端入口、前端文件、数据库和插件系统，辅助开发者探索和理解项目架构。

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

Trigger Scenarios

探索代码库结构查找特定组件或文件路径了解项目架构和配置

Install

npx skills add netalertx/NetAlertX --skill project-navigation -g -y

More Options

Non-standard path

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

Use without installing

npx skills use netalertx/NetAlertX@project-navigation

指定 Agent (Claude Code)

npx skills add netalertx/NetAlertX --skill project-navigation -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": "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/`