Go to file
Moritz Hölting 055206f7c8 fix typo in cargo install command 2024-06-12 18:36:46 +02:00
assets Include namespace when using init command 2024-04-06 21:48:41 +02:00
src change project name from shulkerscript to shulkerscript-cli 2024-06-12 18:27:33 +02:00
.gitignore Add init command 2024-03-27 13:58:09 +01:00
CHANGELOG.md add changelog 2024-06-10 16:55:05 +02:00
Cargo.toml change project name from shulkerscript to shulkerscript-cli 2024-06-12 18:27:33 +02:00
LICENSE.txt update project metadata and license information 2024-06-10 10:02:17 +02:00
README.md fix typo in cargo install command 2024-06-12 18:36:46 +02:00

README.md

Shulkerscript cli tool

This is a cli tool for the shulkerscript language. It can be used to initialize a new project, and to compile and package a project.

Installation

cargo install --git https://github.com/moritz-hoelting/shulkerscript-cli.git

Usage

Initialize a new project

shulkerscript init [OPTIONS] [PATH]

Where [PATH] is the path of the folder to initialize in [default: .]

Options:

  • --name <NAME> The name of the project
  • --description <DESCRIPTION> The description of the project
  • --pack-format <PACK_FORMAT> The pack format version
  • --force Force initialization even if the directory is not empty

Build a project

shulkerscript build [OPTIONS] [PATH]

Where [PATH] is the path of the project folder to build [default: .]

Options:

  • --output <OUTPUT> The output directory, overrides the DATAPACK_DIR environment variable

Environment variables:

  • DATAPACK_DIR The output directory [default: ./dist]

Clean the output directory

shulkerscript clean [OPTIONS] [PATH]

Where [PATH] is the path of the project folder to clean [default: .]

Options:

  • --output <OUTPUT> The output directory, overrides the DATAPACK_DIR environment variable

Environment variables:

  • DATAPACK_DIR The output directory [default: ./dist]

Package a project

shulkerscript package [OPTIONS] [PATH]

Where [PATH] is the path of the project folder to package [default: .]

Options:

  • --output <OUTPUT> The output directory, overrides the DATAPACK_DIR environment variable

Environment variables:

  • DATAPACK_DIR The output directory [default: ./dist]

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Note that this repository only contains the cli tool for interfacing with the language. The language itself is located in the shulkerscript-lang repository. Please indicate if pull requests for this repository require pull requests for the language repository