Skip to main content

Search and collect V2Ray servers from GitHub repositories

Project description

v2ray-finder

PyPI version Python Versions Tests Code Quality License: Apache 2.0 GitHub Stars

فارسی | English | Deutsch | 📋 CHANGELOG


A high-performance tool to fetch, aggregate, validate and health-check public V2Ray server configs from GitHub and curated subscription sources.

Built with love for eternal freedom ❤️


🗂️ Repository Structure

This is a monorepo containing two independent implementations of v2ray-finder:

Directory Language Description
(root) 🐍 Python Original Python implementation — PyPI package, CLI, GUI
dotnet/ ⚡ .NET / C# .NET port — contributed by the community

Each implementation is self-contained. You can use either one independently.


🐍 Python — Quick Start

from v2ray_finder import Pipeline, StopController

pipeline = Pipeline(check_health=True)
result = pipeline.run()
for score in result.scores[:5]:
    print(score.grade, score.config[:80])
pip install v2ray-finder                # core
pip install "v2ray-finder[async]"       # + httpx for concurrent fetch
pip install "v2ray-finder[all]"         # everything

Full Python docs: README.en.md | فارسی: README.fa.md | Changelog: CHANGELOG.md


⚡ .NET — Quick Start

See dotnet/README.md for installation and usage.


🚀 What's New in v0.7.0 (Python)

🛡️ Structured error modelFetchResult.structured_error with category / kind / message hierarchy (V1-D2)
🔄 xray Layer-3 port-contention retry — auto-retry on a fresh OS port when xray fails to bind (V1-D4)
🖥️ GUI fully migrated to Pipeline — Stop button, real progress bar, Score/Grade/Latency columns, Failed Sources panel (V1-A2)


🧪 Test Coverage (Python)

~85% across Python 3.8–3.12, Linux, macOS & Windows.


📝 License

Apache License 2.0 © 2026 Ali Sadeghi Aghili

This project is licensed under the Apache License 2.0. Any derivative work, port, or redistribution must retain the NOTICE file and credit the original author. See LICENSE for full terms.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

v2ray_finder-0.7.0.tar.gz (131.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

v2ray_finder-0.7.0-py3-none-any.whl (80.5 kB view details)

Uploaded Python 3

File details

Details for the file v2ray_finder-0.7.0.tar.gz.

File metadata

  • Download URL: v2ray_finder-0.7.0.tar.gz
  • Upload date:
  • Size: 131.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for v2ray_finder-0.7.0.tar.gz
Algorithm Hash digest
SHA256 3fc79199dcdf3c8b5e992a3b2560655bdf8d95a829d83ef4e6268e8458f90fdf
MD5 fd09a5ce11eee8f32008e83acc6d2594
BLAKE2b-256 80a8c96060696f64df93095ee72b4f2ba93fa432f3f1d707cdd433ed2cd3b688

See more details on using hashes here.

File details

Details for the file v2ray_finder-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: v2ray_finder-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 80.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for v2ray_finder-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a2596b7555fe7dc0d915a7c1ad8224c389e3cd1d3b6ae156e53b712854223f9
MD5 fcd8113c39abdcd2895da018556f7424
BLAKE2b-256 f42684613715e274959f1af01d1750bb0920e2ead2e62a9a2855c1efb00b9cb6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page