Aller au contenu principal

Utiliser la CLI

Pour signaler une erreur dans ce document ou proposer une amélioration, laissez un message sur le forum Mudfish (https://forums.mudfish.net).

Je ne sais pas combien d’utilisateurs de Mudfish utiliseront ce menu, mais si vous le faites, vous êtes probablement un utilisateur avancé. :-) Bienvenue !

Les sections suivantes emploient davantage de termes techniques ; lisez-les attentivement.

Présentation de la CLI​

Avant la création de Mudfish Launcher, la CLI (Command Line Interface) était le seul moyen de débogage. Aujourd’hui, la configuration passe principalement par l’interface graphique, et la CLI est rarement utilisée.

Elle reste toutefois le seul moyen disponible pour analyser certains problèmes, effectuer les réglages les plus poussés et consulter des états internes invisibles dans l’interface.

Accéder à la CLI​

Vous devez d’abord connaître l’adresse IP et le port d’écoute de la CLI.

  • Connectez-vous à Mudfish.
  • Ouvrez « État → Processus » et trouvez la section des journaux. Elle contient les messages émis par mudfish.exe depuis son démarrage.
  • En haut du journal, la ligne « [INFO] Listening the mangement console... » indique l’adresse IP et le port de la CLI. L’adresse est toujours l’adresse locale 127.0.0.1 ; le port est attribué automatiquement par le système.

Depuis une invite de commandes, utilisez telnet avec cette adresse et ce port. Pour 127.0.0.1:35323, par exemple :

   C:\> telnet 127.0.0.1 35323

   -----------------------------
   MUDFISH CLI v2.0.8
   -----------------------------

   Type 'help' for command list.
   Type 'quit' to close CLI session.

Commandes CLI​

Une petite erreur dans une commande CLI peut provoquer un échec d’assertion et arrêter Mudfish. Le développeur a conçu cette fonction de manière vraiment très orientée développeurs…

Mudfish Core repose sur la pile TCP/IP et l’infrastructure réseau de FreeBSD (c’est le système que je connais le mieux… hum…). Les commandes de la CLI ressemblent donc beaucoup à celles de FreeBSD, tant par leurs fonctions que par leur utilisation.

Une fois connecté, exécutez help pour afficher les commandes prises en charge.

   help
       arp                 Address resolution display and control
       connect             Test a connection to the remote
       help                Show this help message
       ifconfig            Configure network interface parameters
       netstat             Show network status
       ping                send ICMP ECHO_REQUEST packets to network hosts
       route               Manually manipulate the routing tables
       quit                Exit CLI interface
       sysctl              Get or set kernel state

Pour une description complète de chaque commande, recherchez-la dans les pages de manuel FreeBSD. À l’exception de connect, elles doivent fonctionner comme dans FreeBSD 8.0 RELEASE.

Commande connect​

   connect
   usage: connect ip port

   connect 68.180.206.184 80
   connection was good (RTT 0.156 secs)

Cette commande tente une connexion TCP connect(2) via les interfaces virtuelles Mudfish re(4) ou msk(4). Elle sert au débogage pour déterminer si une adresse IP et un port sont joignables via Mudfish.

En cas d’échec, une erreur ou un message Timeout s’affiche. En cas de réussite, le RTT estimé est affiché.