Platform_CLI

Multipacks CLI is the main method of interacting Multipacks. All you need is a terminal (which is available on every systems) and Java 17+.

Using Multipacks CLI

If you haven't installed Multipacks CLI, consider installing it before continuing at this point. Check out our Installation Guide if you want to install Multipacks CLI.

Typing multipacks-cli in the terminal will display this cool help message:

$ multipacks-cli
Multipacks CLI
Usage: java multipacks.cli.Main <subcommand...> [options...]
Subcommands:
  list            List repositories or packs
  pack            Pack command

Options:
  -F  --filter <ID> [>=, >, <=, <]<Version>
        Set filter for querying packs
  -R  --repo <'#' + Index | 'file:/path/'>
        Select repository (see index with 'list repo')
  -O  --output </path/to/output>
        Set output path
      --skip
        Skip 'pack init' prompts
      --ignore-errors
        Ignore errors as much as possible
  -I  --ignore <Pack feature>
        Ignore pack features (use -I multiple times to ignores more)
        Available features to ignore: licenses
      --include <Pack type A, Pack type B...>
        Include 1 or more different pack types to output. The parameter is separated with comma (',') character
        Available pack types: none, resources, licenses, data
  -W  --watch
        Watch for any changes (usable with pack build)
      --plugin </path/to/plugin.jar>
        Load Multipacks Engine plugin from a JAR file
        By default, this will not load any plugin but the integrated one
$ # TODO: Command-line interface rework

Please ignore java multipacks.cli.Main: It is actually another way to use Multipacks CLI, but end users can just use multipacks-cli instead.

Options

Options can be inserted at anywhere in your command, as long as they are started with a dash (-):

$ multipacks-cli -O coolkid.zip pack build yolo -W

Subcommands

Unlink options, subcommands are sequential. That means you can't type subcommands at any order that you want:

$ multipacks-cli pack build yolo # Correct
$ multipacks-cli build pack yolo # Incorrect

Getting help

Typing multipacks-cli without any options or subcommands will display the help message above, while typing subcommand without another subcommand behind it will display a small help message, something like this:

$ multipacks-cli pack
No subcommand for 'pack'
All subcommands for 'pack':
  init [path]     Create an empty Multipacks pack
  info [path]     Gather Multipacks pack informations
  build [path]    Build Multipacks pack to game resources or data pack
  install [path]  Install Multipacks pack to selected repository

Typing invalid subcommand will display this generic message:

$ multipacks-cli pack buil
Unknown subcommand for 'pack': buil