Skip to content

Rezn1r/mcfetch

Repository files navigation

mcfetch

A fast and beautiful CLI tool to fetch and display Minecraft server status.

Screenshot of mcfetch

Features

  • Support for both Java and Bedrock editions
  • Beautiful TUI output
  • Verbose mode for detailed server information
  • Single binary, no dependencies required

Installation

Quick Install

Windows (PowerShell):

irm https://raw.githubusercontent.com/Rezn1r/mcfetch/main/installer.ps1 | iex

Linux/macOS:

curl -sSL https://raw.githubusercontent.com/Rezn1r/mcfetch/main/installer.sh | bash

From Source

git clone https://github.com/Rezn1r/mcfetch.git
cd mcfetch
go build -o mcfetch

Usage

mcfetch <java|bedrock> <host> [port] [flags]

Arguments

  • <edition>: Server edition - java or bedrock
  • <host>: Server hostname or IP address
  • [port]: Server port (optional, uses edition default if omitted)

Flags

  • --verbose: Display extra details (EULA, cache, mods, plugins, SRV records)
  • --dry-run: Show what would be fetched without making API calls
  • --version: Print version information and exit
  • --no-color: Disable colorized output
  • --update: Update mcfetch to the latest release
  • --uninstall: Uninstall mcfetch from this system

Examples

Basic Usage

Fetch Java server status (uses default port 25565):

mcfetch java donutsmp.net

Fetch Bedrock server status with custom port:

mcfetch bedrock demo.mcfetch.io 19132

With Flags

Verbose output with extra details:

mcfetch java donutsmp.net --verbose

Clean output without colors:

mcfetch java donutsmp.net --no-color

Test without making API call:

mcfetch java donutsmp.net --dry-run

Combine multiple flags:

mcfetch bedrock play.example.com 19132 --verbose --no-color

Verbose Mode

With --verbose, additional information is displayed:

  • IP address
  • EULA status
  • Cache timestamps
  • Number of mods
  • Number of plugins
  • SRV record (if available)

Requirements

  • Go 1.21 or higher (for building from source)

Dependencies

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

Acknowledgments

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published