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

CONTRIBUTING.md's CLI section improved.

Browse Source 
Details:
 - Installing `typer-cli` note added.
 - CLI name set to empty string to match the current document.
This commit is contained in:
Alireza Jafari
2024-04-06 23:36:04 +03:30
parent 31c3c949c4
commit b038f5eecf
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@@ -48,10 +48,10 @@ Frontend is pre-built and served by FastAPI from the `app/dashboard/build` direc
Frontend uses `Chakra-UI` as the component library, so please adhere to the Chakra-UI approach when contributing. Strive to create components that are cohesive and serve a single purpose. Keep in mind that readability and maintainability are more important than brevity, so prioritize those factors when writing your code.
## Marzban CLI
Marzban CLI is built using [Typer](https://typer.tiangolo.com/), and its commands' code can be found in `cli` directory. Its documentation is generated using [Typer CLI](https://typer.tiangolo.com/typer-cli/) which can be re-generated by navigating to project's root directory and running the following command:
Marzban CLI is built using [Typer](https://typer.tiangolo.com/), and its commands' code can be found in `cli` directory. Its documentation is generated using [Typer CLI](https://typer.tiangolo.com/typer-cli/) which can be re-generated by navigating to project's root directory and running the following command (`typer-cli` package needs to be installed first):
```bash
$ PYTHONPATH=$(pwd) typer marzban-cli.py utils docs --name "marzban-cli" --output ./cli/README.md
$ PYTHONPATH=$(pwd) typer marzban-cli.py utils docs --name "" --output ./cli/README.md
```
## Debug Mode