CLI utility for managing Xray VPN server user accounts with ease, written in Python.
Project description
Introduction
PyXrayC is a CLI tool built with Python and Typer library that helps you to manage your Xray VPN server's user accounts with ease.
Features
- Installable via
pip - Fully type hinted and extensible code base.
- User friendly and easy to use interface.
- Optional shell autocompletion.
- Add, view or delete users to/from your config file.
Requirements
- A Linux distribution with Xray VPN server installed on it.
- Python 3.8 or higher.
Installation
You can install PyXrayC from PyPI using pip:
$ pip3 install pyxrayc
Usage
You can see PyXrayC's help message by running:
$ pyxrayc --help
Configuration
PyXrayC uses below environment variables as its configuration:
XRAY_CONFIG_PATH: Path to the config file. Default:/usr/local/etc/xray/config.jsonXRAY_BACKUP_PATH: Path to the backup file. Default:/usr/local/etc/xray/backup.json
License
This project is licensed under the terms of the GPL-3.0 licence.
— ⚡ —
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyxrayc-0.1.3.tar.gz
(18.0 kB
view details)
Built Distribution
pyxrayc-0.1.3-py3-none-any.whl
(30.9 kB
view details)
File details
Details for the file pyxrayc-0.1.3.tar.gz.
File metadata
- Download URL: pyxrayc-0.1.3.tar.gz
- Upload date:
- Size: 18.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.2 CPython/3.8.15 Linux/5.15.0-1024-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6c775910864536b1c22e12a2c8b697eb0d3056b21408456cabcbea7a78becaa3
|
|
| MD5 |
9e93f229ce1708dc993eda788e86f945
|
|
| BLAKE2b-256 |
946d008a7b2ab197e34518b945095c4f1376f74e25843c3837c52897e1c86c73
|
File details
Details for the file pyxrayc-0.1.3-py3-none-any.whl.
File metadata
- Download URL: pyxrayc-0.1.3-py3-none-any.whl
- Upload date:
- Size: 30.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.2 CPython/3.8.15 Linux/5.15.0-1024-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cee0441bd0cff1095b9e5d8f13949ecfe6b8dfb00859c3c7dac2de27eb2ae32e
|
|
| MD5 |
17cff8710079c414d0aadbb89c0c3ec9
|
|
| BLAKE2b-256 |
fff43844fda717e2ab79bf9b478baeb8feceea52e3b875ab9782d914cd891397
|
