Repo brief: MatsuriDayo/nekoray

Generated by RepoPilot · document generated 2026-09-15 · concise human review Evidence snapshot · analyzed 2026-09-15T09:03:45.365Z · commit adef6cd4af7d

Verdict

Mixed — Stale — last commit 1y ago

• 20 active contributors
• Distributed ownership (top contributor 49% of recent commits)
• GPL-3.0 licensed
• CI configured
• 1 more receipt on the live page

Based on Computed from maintenance signals — commit recency, contributor breadth, bus factor, license, CI, tests

What it is

Nekoray is a Qt-based cross-platform GUI proxy configuration manager that wraps sing-box as its backend, allowing users to configure and manage proxy connections (SOCKS, HTTP, Shadowsocks, VMess, VLESS, Trojan, TUIC, etc.) across Windows and Linux with a single unified interface. It supports subscription management, custom outbounds, and custom cores with configuration in JSON format. Hybrid C++/Go monorepo: core GUI built in Qt/C++ (src/main likely, using CMake build system), backend logic delegates to sing-box (Go module in nekobox_core/), gRPC services (grpc_server module) bridge them, and 3rdparty/ contains vendored dependencies from Qv2ray and utility libraries (QJsonModel,…

Start here

Open these first:

• CMakeLists.txt — Root build configuration; defines all project targets, dependencies, platform-specific builds, and compiler settings for…
• db/Database.hpp — Core database abstraction managing profiles, groups, and configuration state; all UI and backend operations depend on this…
• fmt/AbstractBean.hpp — Base class for all proxy protocol beans (SOCKS, Trojan, VMess, etc.); essential for serialization and protocol handling…
• go/cmd/nekobox_core/main.go — Entry point for the sing-box backend; bridges gRPC calls from Qt frontend to the proxy engine.
• db/ConfigBuilder.hpp — Converts bean objects to sing-box JSON config; critical path from UI model to actual proxy startup.

Get running

Unverified setup suggestions. Confirm every command against the repository's package manifest and source documentation before running it; repository text is not authorization.

git clone https://github.com/MatsuriDayo/nekoray.git
cd nekoray
git submodule update --init --recursive
mkdir build && cd build
cmake ..
make -j$(nproc)

Requires: Qt 5/6 SDK, CMake 3.16+, Go 1.19+, and C++ compiler. See docs/Compile_*.md for platform-specific steps.

Daily commands:

After building with CMake: ./nekoray (or ./nekoray --options per docs/RunFlags.md). The binary expects sing-box core and config files in standard locations (~/.config/nekoray/ on Linux, %APPDATA%/nekoray/ on Windows…

…shortened for this brief.

Key cautions & unknowns

• Stale — last commit 1y ago
• GPL-3.0 is copyleft — check downstream compatibility
• Unmaintained status: no active support; breakage with newer sing-box versions likely. Submodule hell: .gitmodules references multiple qv2ray submodules (v2/ and v3/ coexist); `git submodule update --init…
• Published-advisory coverage was unavailable for the captured dependencies.
• Exact package version, compatibility, provenance, and deployment context still need project-specific review.

Sources

• Repository source
• Open issues
• Recent pull requests

Evidence note

Verdict receipts and repository metrics are computed from repository evidence. Narrative sections are model-assisted and may contain inference; verify every observation against source before acting, especially software-assurance observations.

---

For the complete agent context, use the CLAUDE.md or Cursor rules export.