mc-cli

• Usage
• Commands

Usage

$ npm install -g @ambitioncraft/cli
$ mc COMMAND
running command...
$ mc (-v|--version|version)
@ambitioncraft/cli/0.1.0 linux-x64 node-v13.14.0
$ mc --help [COMMAND]
USAGE
  $ mc COMMAND
...

Commands

• mc execute INSTANCENAME MCCOMMAND
• mc help [COMMAND]
• mc instance COMMAND
• mc list INSTANCENAME
• mc make-server NAME
• mc make-world INSTANCENAME WORLDNAME
• mc mcprop INSTANCENAME
• mc mspt INSTANCENAME
• mc scoreboard INSTANCENAME OBJECTIVE
• mc start INSTANCENAME
• mc status INSTANCENAME
• mc stop INSTANCENAME

mc execute INSTANCENAME MCCOMMAND

Execute a command using rcon

USAGE
  $ mc execute INSTANCENAME MCCOMMAND

ARGUMENTS
  INSTANCENAME  Name of the server instance
  MCCOMMAND     Minecraft command to execute

OPTIONS
  -h, --help  display command help

ALIASES
  $ mc run

EXAMPLES
  $ mc execute uhc whitelist add ilmango
  $ mc run give ilmango minecraft:stone_axe

See code: src/commands/execute.ts

mc help [COMMAND]

display help for mc

USAGE
  $ mc help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

mc instance COMMAND

Execute a command across one or more instances

USAGE
  $ mc instance COMMAND

ARGUMENTS
  COMMAND  command to execute

OPTIONS
  -a, --all                execute command for all instances
  -i, --instance=instance  instance to use

ALIASES
  $ mc i

EXAMPLES
  $ mc instance mspt --all
  $ mc i status -i=uhc -i=uhc2

See code: src/commands/instance.ts

mc list INSTANCENAME

list all players on a server

USAGE
  $ mc list INSTANCENAME

ARGUMENTS
  INSTANCENAME  Name of the server instance

OPTIONS
  -h, --help  display command help

EXAMPLE
  $ mc list uhc

See code: src/commands/list.ts

mc make-server NAME

Create a new Minecraft server instance.

USAGE
  $ mc make-server NAME

ARGUMENTS
  NAME  Name of the server instance. Must be lowercase and contain only letters, numbers, underscore, and hypens.

OPTIONS
  -h, --help         display command help
  -i, --image=image  (required) Minecraft Image Name (1.16.1, paper_1.16.3, ...)

ALIASES
  $ mc mkserver

EXAMPLES
  $ mc make-server
  $ mc make-server uhc
  $ mc mkserver uhc --image=1.16.2

See code: src/commands/make-server.ts

mc make-world INSTANCENAME WORLDNAME

Create a new world on the same server.

USAGE
  $ mc make-world INSTANCENAME WORLDNAME

ARGUMENTS
  INSTANCENAME  Name of the server instance
  WORLDNAME     Name of the new world

OPTIONS
  -h, --help       display command help
  -r, --remake     remake the current world. This can only be done if the world was flagged as temporary
  -s, --seed=seed  seed of new world
  -t, --temp       helper to indicate this world is only temporary

ALIASES
  $ mc mkworld

EXAMPLES
  $ mc make-world uhc MyWorld --seed=19094829123
  $ mc make-world speedrun setseedworld --temp
  $ mc make-world speedrun setseedworld --temp --remake
  $ mc mkworld speedrun setseedworld -tr

See code: src/commands/make-world.ts

mc mcprop INSTANCENAME

change a setting in minecraft.properties

USAGE
  $ mc mcprop INSTANCENAME

ARGUMENTS
  INSTANCENAME  Name of the server instance

OPTIONS
  -h, --help  display command help

EXAMPLE
  $ mc mcprop uhc level-name="my world"

See code: src/commands/mcprop.ts

mc mspt INSTANCENAME

get the mspt of a server

USAGE
  $ mc mspt INSTANCENAME

ARGUMENTS
  INSTANCENAME  Name of the server instance

OPTIONS
  -h, --help  display command help

EXAMPLE
  $ mc mspt uhc

See code: src/commands/mspt.ts

mc scoreboard INSTANCENAME OBJECTIVE

displays the scoreboard associated to a specific objective

USAGE
  $ mc scoreboard INSTANCENAME OBJECTIVE

ARGUMENTS
  INSTANCENAME  Name of the server instance
  OBJECTIVE     name of the scoreboard objective

OPTIONS
  -h, --help       display command help
  -w, --whitelist  only show whitelisted players

ALIASES
  $ mc sb

EXAMPLES
  $ mc scoreboard uhc deaths
  $ mc sb uhc deaths --whitelist
  $ mc sb uhc deaths -w

See code: src/commands/scoreboard.ts

mc start INSTANCENAME

start a server instance

USAGE
  $ mc start INSTANCENAME

ARGUMENTS
  INSTANCENAME  Name of the server instance

OPTIONS
  -h, --help  display command help

EXAMPLE
  $ mc start uhc

See code: src/commands/start.ts

mc status INSTANCENAME

see the status of a server instance

USAGE
  $ mc status INSTANCENAME

ARGUMENTS
  INSTANCENAME  Name of the server instance

OPTIONS
  -h, --help  display command help

EXAMPLE
  $ mc status uhc

See code: src/commands/status.ts

mc stop INSTANCENAME

stop a server instance

USAGE
  $ mc stop INSTANCENAME

ARGUMENTS
  INSTANCENAME  Name of the server instance

OPTIONS
  -h, --help  display command help

EXAMPLE
  $ mc stop uhc

See code: src/commands/stop.ts