mcpr/cli repository overview

⁠MCPR-CLI

The Official MCPR⁠ Command Line Interface.

⁠DISCLAIMER

This project is in alpha! Most features are either non-existent or don't fully work.

⁠Features

• Setup Minecraft Server (Testing In Progress #1⁠)
• Install Plugins (Testing In Progress #2⁠)
• Manage Minecraft Server (Not started)

⁠Usage

⁠Setup Server

$ mcpr setup [servertype] [version]

Example

$ mcpr setup spigot 1.12.1

⁠Search Plugins

$ mcpr search [pluginName]

Example

$ mcpr search dynmap

⁠Install Plugin

$ mcpr install [pluginID]

Example

$ mcpr install dynmap

⁠Getting Started

These instructions will get you up and running with MCPR-CLI.

⁠Prerequisites

You will need a few prerequisites installed to start.

• Java JDK⁠
• Bash (Git Bash⁠ or Windows Subsystem for Linux⁠ will work on Windows)

⁠Install

⁠Linux & macOS

To install MCPR-CLI, run the following command.

$ curl -sSL https://git.io/v5eWu | sudo bash

⁠Windows

To install MCPR-CLI on Windows, download and run the Windows Installer⁠.

⁠Downloads

• Linux
  • Binary⁠
  • RPM Installer⁠
  • DEB Installer⁠
• macOS
  • Binary⁠
  • Installer⁠
• Windows
  • Binary⁠
  • Installer⁠

⁠Verify Installation

To verify your installation, run the following.

$ mcpr --version

⁠Build from Source

Go must be installed

# getting:
go get github.com/mcpr/mcpr-cli
cd $GOPATH/src/github.com/mcpr/mcpr-cli
gdm restore

# building
go build -o mcpr

⁠Contributing

Please read CONTRIBUTING.md⁠ for details on our code of conduct, and the process for submitting pull requests to us.

⁠Versioning

We use SemVer⁠ for versioning. For the versions available, see the tags on this repository⁠.

⁠Authors

• Noah Prail - Maintainer - @nprail⁠

See also the list of contributors⁠ who participated in this project.

⁠License

This project is licensed under the MIT License - see the LICENSE⁠ file for details

⁠Acknowledgments

• Hat tip to anyone who's code was used
• Inspired by MSCS⁠