# v2raycli
[](https://pypi.org/project/v2raycli/)
[](https://github.com/narugo1992/v2raycli/actions?query=workflow%3A%22Docs+Deploy%22)
[](https://github.com/narugo1992/v2raycli/actions?query=workflow%3A%22Code+Test%22)
[](https://github.com/narugo1992/v2raycli/actions?query=workflow%3A%22Package+Release%22)
[](https://codecov.io/gh/narugo1992/v2raycli)
[](https://github.com/narugo1992/v2raycli/stargazers)
[](https://github.com/narugo1992/v2raycli/network)
[](https://github.com/narugo1992/v2raycli/issues)
[](https://github.com/narugo1992/v2raycli/pulls)
[](https://github.com/narugo1992/v2raycli/graphs/contributors)
[](https://github.com/narugo1992/v2raycli/blob/master/LICENSE)
Python CLI for v2ray.
## Quick Start
You can install `v2raycli` with PyPI
```shell
pip install v2raycli
```
or with source code
```shell
git clone https://github.com/narugo1992/v2raycli.git
cd v2raycli
pip install .
```
Then you need to download v2ray CLI from [here](https://github.com/v2ray/dist/)
After that, we can start your local proxy service
```shell
# Use your own subscription url
export V2RAY_SUBSCRIPTION='https://jmssub.net/members/getsub.php?service=777777&id=4c646243-6c01-42f4-a4f1-eef212b2e659'
# Use your own v2ray binary executable
export V2RAY_BIN=./bin/v2ray
v2raycli list # List the sites in subscription
v2raycli run # Start the proxy (socks5 protocol, port 17777)
v2raycli run -P http -p 16384 # Start at port 16384 with http protocol
v2raycli run -R # DO NOT ASK ME! Just randomly use one site
```
Raw data
{
"_id": null,
"home_page": "https://github.com/narugo1992/v2raycli",
"name": "v2raycli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Python CLI for v2ray and subscription.",
"author": "narugo1992",
"author_email": "narugo@126.com",
"download_url": "https://files.pythonhosted.org/packages/4b/60/38b8ce5822cbc4175ce97cc061eb5b03f6a044fb081ec84c87b5e8b7696d/v2raycli-0.1.0.tar.gz",
"platform": null,
"description": "# v2raycli\n\n[](https://pypi.org/project/v2raycli/)\n\n\n[](https://github.com/narugo1992/v2raycli/actions?query=workflow%3A%22Docs+Deploy%22)\n[](https://github.com/narugo1992/v2raycli/actions?query=workflow%3A%22Code+Test%22)\n[](https://github.com/narugo1992/v2raycli/actions?query=workflow%3A%22Package+Release%22)\n[](https://codecov.io/gh/narugo1992/v2raycli)\n\n\n[](https://github.com/narugo1992/v2raycli/stargazers)\n[](https://github.com/narugo1992/v2raycli/network)\n\n[](https://github.com/narugo1992/v2raycli/issues)\n[](https://github.com/narugo1992/v2raycli/pulls)\n[](https://github.com/narugo1992/v2raycli/graphs/contributors)\n[](https://github.com/narugo1992/v2raycli/blob/master/LICENSE)\n\nPython CLI for v2ray.\n\n## Quick Start\n\nYou can install `v2raycli` with PyPI\n\n```shell\npip install v2raycli\n```\n\nor with source code\n\n```shell\ngit clone https://github.com/narugo1992/v2raycli.git\ncd v2raycli\npip install .\n```\n\nThen you need to download v2ray CLI from [here](https://github.com/v2ray/dist/)\n\nAfter that, we can start your local proxy service\n\n```shell\n# Use your own subscription url\nexport V2RAY_SUBSCRIPTION='https://jmssub.net/members/getsub.php?service=777777&id=4c646243-6c01-42f4-a4f1-eef212b2e659'\n# Use your own v2ray binary executable\nexport V2RAY_BIN=./bin/v2ray\n\nv2raycli list # List the sites in subscription\nv2raycli run # Start the proxy (socks5 protocol, port 17777)\nv2raycli run -P http -p 16384 # Start at port 16384 with http protocol\nv2raycli run -R # DO NOT ASK ME! Just randomly use one site\n```\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "Python CLI for v2ray and subscription.",
"version": "0.1.0",
"split_keywords": [
"python",
"cli",
"for",
"v2ray",
"and",
"subscription."
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "db948203abd9c6e7bcf66d8b631a810e",
"sha256": "06aeffc040a6be56b406195a6d72ed7c853081ccfed89cfbc5a583f426bf7b53"
},
"downloads": -1,
"filename": "v2raycli-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db948203abd9c6e7bcf66d8b631a810e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 23807,
"upload_time": "2023-01-02T09:48:16",
"upload_time_iso_8601": "2023-01-02T09:48:16.371821Z",
"url": "https://files.pythonhosted.org/packages/97/72/d4387a2b583e41275e8e651421469f738a5b5f6fc18245b43c223ac985cf/v2raycli-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "79c97d3b04c344a262e97fbdabb7de31",
"sha256": "79d32ea45fc018305ff788b8a923d1a4b59a26f38e13b6712a9db266809bf869"
},
"downloads": -1,
"filename": "v2raycli-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "79c97d3b04c344a262e97fbdabb7de31",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 21204,
"upload_time": "2023-01-02T09:48:17",
"upload_time_iso_8601": "2023-01-02T09:48:17.666542Z",
"url": "https://files.pythonhosted.org/packages/4b/60/38b8ce5822cbc4175ce97cc061eb5b03f6a044fb081ec84c87b5e8b7696d/v2raycli-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-02 09:48:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "narugo1992",
"github_project": "v2raycli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
">=",
"2.18"
]
]
},
{
"name": "click",
"specs": [
[
">=",
"7"
]
]
},
{
"name": "tabulate",
"specs": [
[
">=",
"0.8.0"
]
]
},
{
"name": "inquirerpy",
"specs": [
[
">=",
"0.3.0"
]
]
},
{
"name": "hbutils",
"specs": [
[
">=",
"0.7.6"
]
]
},
{
"name": "pysocks",
"specs": [
[
">=",
"1.6.0"
]
]
}
],
"lcname": "v2raycli"
}
JSON
