Skip to content

Infrarust CLI Documentation

Overview

Infrarust features a built-in command-line interface (CLI) for managing and monitoring your Minecraft proxy. The CLI provides real-time control over connected players, server configurations, and security features without requiring server restarts.

Table of Contents

Getting Started

When running Infrarust, the CLI is automatically available and provides a prompt (>) where you can enter commands:

> help

To see a list of all available commands, use the help command. For detailed information about specific commands, refer to the appropriate command page in this documentation.

Command Summary

CommandDescriptionDocumentation
listLists all connected players by serverCommon Commands
kickKicks a player from the serverCommon Commands
configsLists all server configurationsCommon Commands
banBans a playerBan System Commands
unbanRemoves a banBan System Commands
bansLists all active bansBan System Commands
debugShows detailed debug informationDiagnostic Commands
tasksShows background task informationDiagnostic Commands
helpShows help informationCommon Commands
exit/quitExits the programCommon Commands

Colored Output

Infrarust CLI uses colored output to improve readability:

  • Green: Success messages, headers
  • Cyan: Entity names (players, servers), configuration names
  • Yellow: Warnings
  • Red: Errors
  • Gray: Secondary information, IDs
  • Bold: Labels, important information

Non-Interactive Mode

Infrarust can also accept commands from standard input in non-interactive mode, which is useful for scripting or when running in a container. When running in non-interactive mode, the command prompt > is not displayed.

Example (using echo and pipe):

bash
echo "list" | ./infrarust

This allows you to automate commands or create management scripts for your Infrarust server.

Released under the AGPL-3.0 License.