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.json
XRAY_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.
— ⚡ —
Project details
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 hashes)
Built Distribution
pyxrayc-0.1.3-py3-none-any.whl
(30.9 kB
view hashes)