rms/Marzban
1
0
Fork 0
mirror of https://github.com/Gozargah/Marzban.git synced 2026-05-17 08:35:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix: marzban-cli, hidden completion app, CLI_PROG_NAME env

Browse Source
This commit is contained in:
SaintShit
2023-05-30 16:13:00 +03:30
parent 71779d409e
commit 6b62a4b144
5 changed files with 133 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Dockerfile
View File

@@ -18,6 +18,6 @@ RUN apt-get remove -y curl unzip gcc python3-dev
RUN ln -s /code/marzban-cli.py /usr/bin/marzban-cli \
&& chmod +x /usr/bin/marzban-cli \
&& marzban-cli --install-completion bash
&& marzban-cli completion install --shell bash
CMD ["bash", "-c", "alembic upgrade head; python main.py"]

2
README-fa.md
View File

@@ -165,7 +165,7 @@ alembic upgrade head
```bash
sudo ln -s $(pwd)/marzban-cli.py /usr/bin/marzban-cli
sudo chmod +x /usr/bin/marzban-cli
marzban-cli --install-completion
marzban-cli completion install
```
حالا یک کپی از `.env.example` با نام `.env` بسازید و با یک ادیتور آن را باز کنید و تنظیمات دلخواه خود را انجام دهید. یه عنوان مثال نام کاربری و رمز عبور را می توانید در این فایل تغییر دهید.

2
README.md
View File

@@ -162,7 +162,7 @@ If you want to use `marzban-cli`, you should link it to a file in your `$PATH`,
```bash
sudo ln -s $(pwd)/marzban-cli.py /usr/bin/marzban-cli
sudo chmod +x /usr/bin/marzban-cli
marzban-cli --install-completion
marzban-cli completion install
```
Now it's time to configuration

113
cli/README.md
View File

@@ -1,29 +1,28 @@
# `marzban-cli`
# CLI
**Usage**:
```console
marzban cli [OPTIONS] COMMAND [ARGS]...
$ [OPTIONS] COMMAND [ARGS]...
```
**Options**:
* `--install-completion`: Install completion for the current shell.
* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
* `--help`: Show this message and exit.
**Commands**:
* `admin`
* `completion`: Generate and install completion scripts.
* `subscription`
* `user`
## `marzban cli admin`
## `admin`
**Usage**:
```console
marzban cli admin [OPTIONS] COMMAND [ARGS]...
$ admin [OPTIONS] COMMAND [ARGS]...
```
**Options**:
@@ -38,7 +37,7 @@ marzban cli admin [OPTIONS] COMMAND [ARGS]...
* `list`: Displays a table of admins
* `update`: Updates the specified admin
### `marzban cli admin create`
### `admin create`
Creates an admin
@@ -47,7 +46,7 @@ Password can also be set using the `MARZBAN_ADMIN_PASSWORD` environment variable
**Usage**:
```console
marzban-cli admin create [OPTIONS]
$ admin create [OPTIONS]
```
**Options**:
@@ -56,7 +55,7 @@ marzban-cli admin create [OPTIONS]
* `--sudo / --no-sudo`
* `--help`: Show this message and exit.
### `marzban-cli admin delete`
### `admin delete`
Deletes the specified admin
@@ -65,7 +64,7 @@ Confirmations can be skipped using `--yes/-y` option.
**Usage**:
```console
marzban cli admin delete [OPTIONS]
$ admin delete [OPTIONS]
```
**Options**:
@@ -74,7 +73,7 @@ marzban cli admin delete [OPTIONS]
* `-y, --yes`: Skips confirmations
* `--help`: Show this message and exit.
### `marzban cli admin import-from-env`
### `admin import-from-env`
Imports the sudo admin from env
@@ -87,7 +86,7 @@ What does it do?
**Usage**:
```console
marzban cli admin import-from-env [OPTIONS]
$ admin import-from-env [OPTIONS]
```
**Options**:
@@ -95,14 +94,14 @@ marzban cli admin import-from-env [OPTIONS]
* `-y, --yes`: Skips confirmations
* `--help`: Show this message and exit.
### `marzban cli admin list`
### `admin list`
Displays a table of admins
**Usage**:
```console
marzban cli admin list [OPTIONS]
$ admin list [OPTIONS]
```
**Options**:
@@ -112,7 +111,7 @@ marzban cli admin list [OPTIONS]
* `-u, --username TEXT`: Search by username
* `--help`: Show this message and exit.
### `marzban cli admin update`
### `admin update`
Updates the specified admin
@@ -121,7 +120,7 @@ NOTE: This command CAN NOT be used non-interactively.
**Usage**:
```console
marzban cli admin update [OPTIONS]
$ admin update [OPTIONS]
```
**Options**:
@@ -129,12 +128,67 @@ marzban cli admin update [OPTIONS]
* `-u, --username TEXT`: [required]
* `--help`: Show this message and exit.
## `marzban cli subscription`
## `completion`
Generate and install completion scripts.
**Usage**:
```console
marzban cli subscription [OPTIONS] COMMAND [ARGS]...
$ completion [OPTIONS] COMMAND [ARGS]...
```
**Options**:
* `--help`: Show this message and exit.
**Commands**:
* `install`: Install completion for the specified shell.
* `show`: Show completion for the specified shell,...
### `completion install`
Install completion for the specified shell.
**Usage**:
```console
$ completion install [OPTIONS] [SHELL]:[bash|zsh|fish|powershell|pwsh]
```
**Arguments**:
* `[SHELL]:[bash|zsh|fish|powershell|pwsh]`: The shell to install completion for.
**Options**:
* `--help`: Show this message and exit.
### `completion show`
Show completion for the specified shell, to copy or customize it.
**Usage**:
```console
$ completion show [OPTIONS] [SHELL]:[bash|zsh|fish|powershell|pwsh]
```
**Arguments**:
* `[SHELL]:[bash|zsh|fish|powershell|pwsh]`: The shell to install completion for.
**Options**:
* `--help`: Show this message and exit.
## `subscription`
**Usage**:
```console
$ subscription [OPTIONS] COMMAND [ARGS]...
```
**Options**:
@@ -146,7 +200,7 @@ marzban cli subscription [OPTIONS] COMMAND [ARGS]...
* `get-config`: Generates a subscription config.
* `get-link`: Prints the given user's subscription link.
### `marzban cli subscription get-config`
### `subscription get-config`
Generates a subscription config.
@@ -158,7 +212,7 @@ The output will be written in the output file when the `output-file` is present,
**Usage**:
```console
marzban cli subscription get-config [OPTIONS]
$ subscription get-config [OPTIONS]
```
**Options**:
@@ -169,7 +223,7 @@ marzban cli subscription get-config [OPTIONS]
* `--base64`: Encodes output in base64 format if present
* `--help`: Show this message and exit.
### `marzban cli subscription get-link`
### `subscription get-link`
Prints the given user's subscription link.
@@ -179,7 +233,7 @@ NOTE: This command needs `XRAY_SUBSCRIPTION_URL_PREFIX` environment variable to
**Usage**:
```console
marzban cli subscription get-link [OPTIONS]
$ subscription get-link [OPTIONS]
```
**Options**:
@@ -187,12 +241,12 @@ marzban cli subscription get-link [OPTIONS]
* `-u, --username TEXT`: [required]
* `--help`: Show this message and exit.
## `marzban cli user`
## `user`
**Usage**:
```console
marzban cli user [OPTIONS] COMMAND [ARGS]...
$ user [OPTIONS] COMMAND [ARGS]...
```
**Options**:
@@ -204,7 +258,7 @@ marzban cli user [OPTIONS] COMMAND [ARGS]...
* `list`: Displays a table of users
* `set-owner`: Transfers user's ownership
### `marzban cli user list`
### `user list`
Displays a table of users
@@ -213,7 +267,7 @@ NOTE: Sorting is not currently available.
**Usage**:
```console
marzban cli user list [OPTIONS]
$ user list [OPTIONS]
```
**Options**:
@@ -225,7 +279,7 @@ marzban cli user list [OPTIONS]
* `--admin, --owner TEXT`: Search by owner admin's username
* `--help`: Show this message and exit.
### `marzban cli user set-owner`
### `user set-owner`
Transfers user's ownership
@@ -234,12 +288,13 @@ NOTE: This command needs additional confirmation for users who already have an o
**Usage**:
```console
marzban cli user set-owner [OPTIONS]
$ user set-owner [OPTIONS]
```
**Options**:
* `-u, --username TEXT`
* `--admin, --owner TEXT`: Admin's username
* `-y, --yes`: Skips confirmation.
* `-y, --yes`: Skips confirmations
* `--help`: Show this message and exit.

52
marzban-cli.py
View File

@@ -1,15 +1,55 @@
#!/usr/bin/env python3
import typer
import os # noqa
import readline # noqa
import cli.admin
import cli.user
import cli.subscription
import sys # noqa
app = typer.Typer(no_args_is_help=True)
sys.path.insert(0, os.getcwd()) # noqa
import typer
from typer._completion_shared import Shells
import cli.admin
import cli.subscription
import cli.user
app = typer.Typer(no_args_is_help=True, add_completion=False)
app.add_typer(cli.admin.app, name="admin")
app.add_typer(cli.subscription.app, name="subscription")
app.add_typer(cli.user.app, name="user")
# Hidden completion app
app_completion = typer.Typer(no_args_is_help=True, help="Generate and install completion scripts.", hidden=True)
app.add_typer(app_completion, name="completion")
def get_default_shell() -> Shells:
shell = os.environ.get('SHELL')
if shell:
shell = shell.split('/')[-1]
if shell in Shells.__members__:
return getattr(Shells, shell)
return Shells.bash
@app_completion.command(help="Show completion for the specified shell, to copy or customize it.")
def show(ctx: typer.Context, shell: Shells = typer.Argument(None,
help="The shell to install completion for.",
case_sensitive=False)) -> None:
if shell is None:
shell = get_default_shell()
typer.completion.show_callback(ctx, None, shell)
@app_completion.command(help="Install completion for the specified shell.")
def install(ctx: typer.Context, shell: Shells = typer.Argument(None,
help="The shell to install completion for.",
case_sensitive=False)) -> None:
if shell is None:
shell = get_default_shell()
typer.completion.install_callback(ctx, None, shell)
if __name__ == "__main__":
app()
typer.completion.completion_init()
app(prog_name=os.environ.get('CLI_PROG_NAME'))