# README
craftctl
craftctl is a command-line Minecraft console client.
Written in Go, craftctl runs on same platforms Minecraft does.
Usage
craftctl uses the RCON protocol to interact with a Minecraft instance.
First, enable the RCON interface:
# server.properties
enable-rcon=true
rcon.password=<password>
then point craftctl to your server:
$ craftctl -p <password> list
Commands
Specify commands with or without a leading slash. The following are equivalent:
$ craftctl help
$ craftctl /help
Configuration
Configure craftctl using command-line flags or environment variables.
Option | Environment Variable | Default | Description |
---|---|---|---|
-H /--host | CRAFTCTL_HOST | localhost | RCON hostname or IP address |
-P /--port | CRAFTCTL_PORT | 25575 | RCON password |
-p /--password | CRAFTCTL_PASSWORD | password | RCON password |
Installation
Install the Go toolchain, then:
$ go get github.com/benwebber/craftctl
$ go install github.com/benwebber/craftctl
# Constants
No description provided by the author
# Variables
No description provided by the author