pnx-cli

PowerNukkitX CLI est un outil en ligne de commande pour gérer un serveur Minecraft Bedrock propulsé par PowerNukkitX.

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.

Installation

npm install -g pnx-cli

Après installation, la commande disponible est pnx.

Prérequis

• Node.js 18 ou plus
• Un dossier de serveur PowerNukkitX si vous souhaitez gérer une installation existante

Démarrage rapide

Lancer le menu interactif :

pnx

Afficher l’aide :

pnx --help

Choisir la langue :

pnx --lang fr

Fonctionnalités

• Initialiser un nouveau serveur PowerNukkitX
• Démarrer le serveur avec options de mémoire et redémarrage automatique
• Installer, lister, rechercher, mettre à jour et supprimer des plugins
• Vérifier l’état du serveur avec un diagnostic intégré
• Créer des sauvegardes du serveur
• Consulter la configuration et les informations du serveur
• Mettre à jour powernukkitx.jar
• Utiliser l’interface en anglais ou en français

Commandes disponibles

Initialiser un serveur

pnx init --dir ./pnx-server

Options :

• -d, --dir <path> : dossier cible
• --dev : installer la version de développement

Démarrer le serveur

pnx start --memory 4G --restart

Options :

• -g, --generate-only : générer la commande de démarrage sans l’exécuter
• -r, --restart : redémarrer automatiquement en cas de crash
• -m, --memory <size> : mémoire allouée, par exemple 2G ou 4G
• -i, --interactive : mode interactif avec prompts

Gérer les plugins

pnx plugin list
pnx plugin search essentials
pnx plugin info <slug>
pnx plugin install <name>
pnx plugin update
pnx plugin remove <name>
pnx plugin installed

Sous-commandes :

• install [names...] : installer un plugin depuis le marketplace ou une URL .jar
• list : afficher les plugins disponibles
• search [term] : rechercher par nom, description ou auteur
• info [slug] : afficher la fiche détaillée d’un plugin
• installed : lister les plugins installés localement
• update [names...] : mettre à jour les plugins installés
• remove [names...] : supprimer des plugins installés

Mettre à jour le serveur

pnx update --force

Options :

• --dev : installer la version de développement
• -f, --force : forcer la mise à jour même si la version correspond

Diagnostics et utilitaires

pnx doctor
pnx backup
pnx config
pnx info
pnx lang --set fr

Mode interactif

Si vous lancez pnx sans sous-commande, l’application ouvre un menu interactif pour :

• créer ou initialiser un serveur
• démarrer le serveur
• gérer les plugins
• mettre à jour PowerNukkitX
• lancer un diagnostic
• effectuer une sauvegarde
• changer la langue

Développement

Installer les dépendances :

npm install

Compiler le projet :

npm run build

Lancer la CLI localement :

npm start

Surveiller les changements TypeScript :

npm run dev

Exécutables autonomes

Le projet fournit aussi des scripts pour générer des exécutables Windows, Linux et macOS :

npm run build:exe:win
npm run build:exe:linux
npm run build:exe:mac

Liens utiles

• Documentation PowerNukkitX : https://docs.powernukkitx.org
• Dépôt PowerNukkitX : https://github.com/PowerNukkitX/PowerNukkitX

Licence

MIT