mc-cli

• Usage
• Commands

• Usage
• Commands

Usage

$ npm install -g @ambitioncraft/cli
$ mc COMMAND
running command...
$ mc (-v|--version|version)
@ambitioncraft/cli/0.3.0 win32-x64 node-v14.16.0
$ mc --help [COMMAND]
USAGE
  $ mc COMMAND
...

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

Commands

• mc download SERVER
• mc execute SERVER MCCOMMAND
• mc help [COMMAND]
• mc list SERVER
• mc mirror SERVER
• mc mspt SERVER
• mc scoreboard SERVER OBJECTIVE
• mc start SERVER
• mc status SERVER
• mc stop SERVER

mc download SERVER

Download individual regions

USAGE
  $ mc download SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -e, --end=end              end region
  -h, --help                 display command help
  -n, --nether=nether        nether region
  -o, --overworld=overworld  overworld region

ALIASES
  $ mc dl

EXAMPLES
  download -o=1.1 -o=1.2
  dl -n=0.1
  dl -e 0.0

See code: src\commands\download.ts

mc execute SERVER MCCOMMAND

Execute a command using rcon

USAGE
  $ mc execute SERVER MCCOMMAND

ARGUMENTS
  SERVER     Name of the server (smp, cmp, copy)
  MCCOMMAND  Minecraft command to execute

OPTIONS
  -h, --help  display command help

ALIASES
  $ mc run

EXAMPLES
  execute cmp whitelist add ilmango
  run copy 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 list SERVER

list all players on a server

USAGE
  $ mc list SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -h, --help  display command help

EXAMPLE
  list cmp

See code: src\commands\list.ts

mc mirror SERVER

Mirror Regions To Copy

USAGE
  $ mc mirror SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -e, --end=end              end region
  -h, --help                 display command help
  -n, --nether=nether        nether region
  -o, --overworld=overworld  overworld region

EXAMPLE
  mirror smp -o=1.1 -o=1.2

See code: src\commands\mirror.ts

mc mspt SERVER

get the mspt of a server

USAGE
  $ mc mspt SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -h, --help  display command help

EXAMPLE
  mspt cmp

See code: src\commands\mspt.ts

mc scoreboard SERVER OBJECTIVE

displays a scoreboard

USAGE
  $ mc scoreboard SERVER OBJECTIVE

ARGUMENTS
  SERVER     Name of the server (smp, cmp, copy)
  OBJECTIVE  name of the scoreboard objective

OPTIONS
  -a, --allplayers  Include all players (not just whitelisted)
  -h, --help        display command help

ALIASES
  $ mc sb

EXAMPLES
  scoreboard smp deaths
  sb copy deaths --allplayers
  sb uhc deaths -a

See code: src\commands\scoreboard.ts

mc start SERVER

start a server instance

USAGE
  $ mc start SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -h, --help  display command help

EXAMPLES
  start smp
  start copy

See code: src\commands\start.ts

mc status SERVER

see the status of a server instance

USAGE
  $ mc status SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -h, --help  display command help

EXAMPLES
  status smp
  status copy

See code: src\commands\status.ts

mc stop SERVER

stop a server instance

USAGE
  $ mc stop SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -h, --help  display command help

EXAMPLES
  $stop smp
  $stop copy

See code: src\commands\stop.ts

• mc backup SERVER
• mc download SERVER
• mc execute SERVER MCCOMMAND
• mc help [COMMAND]
• mc list SERVER
• mc mirror SERVER
• mc mspt SERVER
• mc scoreboard SERVER OBJECTIVE
• mc start SERVER
• mc status SERVER
• mc stop SERVER

mc backup SERVER

Backup individual regions

USAGE
  $ mc backup SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -e, --end=end              end region
  -h, --help                 display command help
  -n, --nether=nether        nether region
  -o, --overworld=overworld  overworld region

EXAMPLES
  backup -o=1.1
  backup -o=0.1 -o=-1.1
  backup -o=0.1 -n=0.0

See code: src/commands/backup.ts

mc download SERVER

Download individual regions

USAGE
  $ mc download SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -e, --end=end              end region
  -h, --help                 display command help
  -n, --nether=nether        nether region
  -o, --overworld=overworld  overworld region

ALIASES
  $ mc dl

EXAMPLES
  download -o=1.1 -o=1.2
  dl -n=0.1
  dl -e 0.0

See code: src/commands/download.ts

mc execute SERVER MCCOMMAND

Execute a command using rcon

USAGE
  $ mc execute SERVER MCCOMMAND

ARGUMENTS
  SERVER     Name of the server (smp, cmp, copy)
  MCCOMMAND  Minecraft command to execute

OPTIONS
  -h, --help  display command help

ALIASES
  $ mc run

EXAMPLES
  execute cmp whitelist add ilmango
  run copy 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 list SERVER

list all players on a server

USAGE
  $ mc list SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -h, --help  display command help

EXAMPLE
  list cmp

See code: src/commands/list.ts

mc mirror SERVER

Mirror Regions To Copy

USAGE
  $ mc mirror SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -e, --end=end              end region
  -h, --help                 display command help
  -n, --nether=nether        nether region
  -o, --overworld=overworld  overworld region

EXAMPLE
  mirror smp -o=1.1 -o=1.2

See code: src/commands/mirror.ts

mc mspt SERVER

get the mspt of a server

USAGE
  $ mc mspt SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -h, --help  display command help

EXAMPLE
  mspt cmp

See code: src/commands/mspt.ts

mc scoreboard SERVER OBJECTIVE

displays a scoreboard

USAGE
  $ mc scoreboard SERVER OBJECTIVE

ARGUMENTS
  SERVER     Name of the server (smp, cmp, copy)
  OBJECTIVE  name of the scoreboard objective

OPTIONS
  -a, --allplayers  Include all players (not just whitelisted)
  -h, --help        display command help

ALIASES
  $ mc sb

EXAMPLES
  scoreboard smp deaths
  sb copy deaths --allplayers
  sb uhc deaths -a

See code: src/commands/scoreboard.ts

mc start SERVER

start a server instance

USAGE
  $ mc start SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -h, --help  display command help

EXAMPLES
  start smp
  start copy

See code: src/commands/start.ts

mc status SERVER

see the status of a server instance

USAGE
  $ mc status SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -h, --help  display command help

EXAMPLES
  status smp
  status copy

See code: src/commands/status.ts

mc stop SERVER

stop a server instance

USAGE
  $ mc stop SERVER

ARGUMENTS
  SERVER  Name of the server (smp, cmp, copy)

OPTIONS
  -h, --help  display command help

EXAMPLES
  $stop smp
  $stop copy

See code: src/commands/stop.ts