en
menu PN X PNX-CLI
more_vert
Switch Language
  1. PowerNukkitX
  2. Get Started

  3. Config

    1. server.properties
    2. nukkit.yml
    3. pnx-cli-config.ini
    4. Anti-xray
    5. Resource Encryption
    6. Compression Acceleration
    7. PNX with WaterDogPE
    8. Flat World

  4. FAQ

    1. To Newcomers
    2. How to use PNX-CLI
    3. Common Questions
    4. Terra Questions
    5. Spawn-point Questions
    6. Convert Worlds

  5. For Devs

    1. Java

      1. Goto JavaDoc

      2. Mod API

        1. Custom Block
        2. Custom Item
        3. Custom Entity
        4. Custom Enchantment

      3. Entity AI

        1. Behavior
        2. Memory
        3. Sensor
        4. Motion Controller
        5. Navigator
        6. Behavior Group
        7. Work Cycle

    2. JavaScript

      1. setup dev env
      2. Base LLSELib dev
      3. Hello World
      4. Basic knowledge
      5. Event Listener
      6. FAQ

    3. Resources

      1. Event List
      2. IDs(block & item)

PNX-CLI

PNX-CLI is a command line tool for PNX. It can help you to install and start PNX quickly. windows using . \pnx.exe to run. linux use . /pnx to run. Hereafter abbreviated to pnx.

Usage

Usage: pnx [-hV] [--config-path=<config-path>] [-l=<lang>] [COMMAND]
      --config-path=<config-path>
                  Select which config file will be used. (Default
                    pnx-cli-config.ini)
  -h, --help      Show this help message and exit.
  -l, --lang, --language=<lang>
                  Select the language to use temporarily to execute this
                    command.
  -V, --version   Print version information and exit.
Commands:
  about             About PowerNukkitX CLI.
  sys-install       Install or uninstall PNX-CLI into the system path.
  sponsor           See the great people who sponsor the PNX program.
  jvm               Check the installed JVMs, install new JVMs or uninstall
                      JVMs.
  server            Configure(install, update) pnx server.
  libs              Check, update or fix the libraries.
  start             Generator start command and start pnx server.
  components, comp  Check, install or uninstall extra components.

Usage: pnx about [-hV]
About PowerNukkitX CLI.
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.

Usage: pnx sys-install [-hVu]
Install or uninstall PNX-CLI into the system path.
  -h, --help        Show this help message and exit.
  -V, --version     Print version information and exit.
  -u, --uninstall   Remove PNX-CLI from the system path.

Usage: pnx sponsor [-hV]
See the great people who sponsor the PNX program.
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.

Usage: pnx jvm [-hV] (check | remote | -i=<install> | uninstall)
Check the installed JVMs, install new JVMs or uninstall JVMs.
  -h, --help              Show this help message and exit.
  -V, --version           Print version information and exit.
      check               Check the installed JVMs.
  -i, install=<install>   Install a new JVM by its vendor name.
      remote              List all available JVMs in the remote PNX central
                            repository.
      uninstall           Uninstall an existed JVM by its vendor name.

Usage: pnx server [-hVu] [--dev] [--latest]
Configure(install, update) pnx server.
  -h, --help                Show this help message and exit.
  -V, --version             Print version information and exit.
      --dev                 Install the preview development version of PNX.
      --latest              Force-choose the latest version of pnx server core.
  -u, -i, update, install   Install or update pnx server core.

Usage: pnx libs [-hV] (-u | check)
Check, update or fix the libraries.
  -h, --help            Show this help message and exit.
  -V, --version         Print version information and exit.
      check             Check libraries.
  -u, -f, fix, update   Install or fix the libraries.

Usage: pnx start [-hVgr] [--stdin=<stdin>]
Generator start command and start pnx server.
  -h, --help            Show this help message and exit.
  -V, --version         Print version information and exit.
  -g, --generate-only   Generate start command only, do not start pnx server.
  -r, --[no-]restart    Auto-restart pnx server if it crashes.
      --stdin=<stdin>   Input into PNX through a specific file.

Usage: pnx components [-hV] (-i=<update> | -c)
Check, install or uninstall extra components.
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.
  -c, check       Check available components.
  -i, -u, update, install=<update>
                  Install or fix an extra component by its name.

Linux Enter the following command to try

chmod +x . /pnx
./pnx jvm install=OracleJDK # Install jdk17, ignore this if you already have it
./pnx

Windows PowerShell Enter the following command to try

.\pnx.exe jvm install=OracleJDK # install jdk17, ignore this if you already have it
.\pnx.exe

Windows CMD Enter the following command to try

pnx.exe jvm install=OracleJDK # install jdk17, ignore this if you already have it
pnx.exe
© PowerNukkitX Dev team