@powernukkitx/cli 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +177 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
# pnx-cli
|
|
2
|
+
|
|
3
|
+
PowerNukkitX CLI est un outil en ligne de commande pour gérer un serveur **Minecraft Bedrock** propulsé par **PowerNukkitX**.
|
|
4
|
+
|
|
5
|
+
Il propose un menu interactif, la gestion des plugins, des outils de diagnostic, des sauvegardes, et des commandes rapides pour initialiser ou démarrer un serveur.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g pnx-cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Après installation, la commande disponible est `pnx`.
|
|
14
|
+
|
|
15
|
+
## Prérequis
|
|
16
|
+
|
|
17
|
+
- [Node.js](https://nodejs.org/) **18 ou plus**
|
|
18
|
+
- Un dossier de serveur PowerNukkitX si vous souhaitez gérer une installation existante
|
|
19
|
+
|
|
20
|
+
## Démarrage rapide
|
|
21
|
+
|
|
22
|
+
Lancer le menu interactif :
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
pnx
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Afficher l’aide :
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
pnx --help
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Choisir la langue :
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
pnx --lang fr
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Fonctionnalités
|
|
41
|
+
|
|
42
|
+
- Initialiser un nouveau serveur PowerNukkitX
|
|
43
|
+
- Démarrer le serveur avec options de mémoire et redémarrage automatique
|
|
44
|
+
- Installer, lister, rechercher, mettre à jour et supprimer des plugins
|
|
45
|
+
- Vérifier l’état du serveur avec un diagnostic intégré
|
|
46
|
+
- Créer des sauvegardes du serveur
|
|
47
|
+
- Consulter la configuration et les informations du serveur
|
|
48
|
+
- Mettre à jour `powernukkitx.jar`
|
|
49
|
+
- Utiliser l’interface en anglais ou en français
|
|
50
|
+
|
|
51
|
+
## Commandes disponibles
|
|
52
|
+
|
|
53
|
+
### Initialiser un serveur
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
pnx init --dir ./pnx-server
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Options :
|
|
60
|
+
|
|
61
|
+
- `-d, --dir <path>` : dossier cible
|
|
62
|
+
- `--dev` : installer la version de développement
|
|
63
|
+
|
|
64
|
+
### Démarrer le serveur
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
pnx start --memory 4G --restart
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Options :
|
|
71
|
+
|
|
72
|
+
- `-g, --generate-only` : générer la commande de démarrage sans l’exécuter
|
|
73
|
+
- `-r, --restart` : redémarrer automatiquement en cas de crash
|
|
74
|
+
- `-m, --memory <size>` : mémoire allouée, par exemple `2G` ou `4G`
|
|
75
|
+
- `-i, --interactive` : mode interactif avec prompts
|
|
76
|
+
|
|
77
|
+
### Gérer les plugins
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
pnx plugin list
|
|
81
|
+
pnx plugin search essentials
|
|
82
|
+
pnx plugin info <slug>
|
|
83
|
+
pnx plugin install <name>
|
|
84
|
+
pnx plugin update
|
|
85
|
+
pnx plugin remove <name>
|
|
86
|
+
pnx plugin installed
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Sous-commandes :
|
|
90
|
+
|
|
91
|
+
- `install [names...]` : installer un plugin depuis le marketplace ou une URL `.jar`
|
|
92
|
+
- `list` : afficher les plugins disponibles
|
|
93
|
+
- `search [term]` : rechercher par nom, description ou auteur
|
|
94
|
+
- `info [slug]` : afficher la fiche détaillée d’un plugin
|
|
95
|
+
- `installed` : lister les plugins installés localement
|
|
96
|
+
- `update [names...]` : mettre à jour les plugins installés
|
|
97
|
+
- `remove [names...]` : supprimer des plugins installés
|
|
98
|
+
|
|
99
|
+
### Mettre à jour le serveur
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
pnx update --force
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Options :
|
|
106
|
+
|
|
107
|
+
- `--dev` : installer la version de développement
|
|
108
|
+
- `-f, --force` : forcer la mise à jour même si la version correspond
|
|
109
|
+
|
|
110
|
+
### Diagnostics et utilitaires
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
pnx doctor
|
|
114
|
+
pnx backup
|
|
115
|
+
pnx config
|
|
116
|
+
pnx info
|
|
117
|
+
pnx lang --set fr
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## Mode interactif
|
|
121
|
+
|
|
122
|
+
Si vous lancez `pnx` sans sous-commande, l’application ouvre un menu interactif pour :
|
|
123
|
+
|
|
124
|
+
- créer ou initialiser un serveur
|
|
125
|
+
- démarrer le serveur
|
|
126
|
+
- gérer les plugins
|
|
127
|
+
- mettre à jour PowerNukkitX
|
|
128
|
+
- lancer un diagnostic
|
|
129
|
+
- effectuer une sauvegarde
|
|
130
|
+
- changer la langue
|
|
131
|
+
|
|
132
|
+
## Développement
|
|
133
|
+
|
|
134
|
+
Installer les dépendances :
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
npm install
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Compiler le projet :
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
npm run build
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
Lancer la CLI localement :
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
npm start
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Surveiller les changements TypeScript :
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
npm run dev
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
## Exécutables autonomes
|
|
159
|
+
|
|
160
|
+
Le projet fournit aussi des scripts pour générer des exécutables Windows, Linux et macOS :
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
npm run build:exe:win
|
|
164
|
+
npm run build:exe:linux
|
|
165
|
+
npm run build:exe:mac
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
## Liens utiles
|
|
169
|
+
|
|
170
|
+
- Documentation PowerNukkitX : https://docs.powernukkitx.org
|
|
171
|
+
- Dépôt PowerNukkitX : https://github.com/PowerNukkitX/PowerNukkitX
|
|
172
|
+
|
|
173
|
+
## Licence
|
|
174
|
+
|
|
175
|
+
MIT
|
|
176
|
+
|
|
177
|
+
|