What is skill-remnawave-xray?

This repository is a reference skill for AI coding agents that focuses on a narrow, fast moving stack: Remnawave, Xray, Caddy in selfsteal mode, and mihomo, which together are used to run and configure a certain kind of VPN proxy setup. Instead of relying on an AI model's memory, which can be outdated, this skill gives the agent accurate, current information pulled directly from official documentation and source code for each of these four tools. The skill works in three modes. As a reference, it answers factual questions about how Remnawave, Xray, Caddy, and mihomo fit together and how their settings interact. As a generator, it turns templates into filled in configuration files, checks that the pieces are consistent with each other, and runs an included Python script called validate.py to confirm the result is correct. As a diagnostic tool, it walks from a symptom, such as a node failing to connect, back to the likely cause and a fix, along with commands to check further. The project is built to work across many different AI coding tools, not just one. It ships a Claude Code plugin that can be installed through a marketplace command, plus separate entry point files for tools like Cursor, GitHub Copilot, Gemini CLI, Windsurf, and OpenAI's cross-tool AGENTS.md standard. All of these entry points are thin routers that point back to the same shared reference material, so the underlying content about the stack is written once and reused everywhere. The README states this material is educational, since the technologies involved relate to privacy and bypassing internet censorship, and it says these should be used within the bounds of local law. The example configuration files included in the repository have placeholder values instead of real domains or keys, so they are templates rather than working setups. The project is released under the AGPL-3.0 license and welcomes pull requests, particularly ones that keep the reference material current with new releases of the underlying tools.