From 73e84920570bc73a2bdf48ef2e7e6743177cd9be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20H=C3=B6lting?= <87192362+moritz-hoelting@users.noreply.github.com> Date: Thu, 13 Jun 2024 10:39:06 +0200 Subject: [PATCH] remove package command and update watch command --- src/content/docs/reference/cli.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/src/content/docs/reference/cli.md b/src/content/docs/reference/cli.md index 644cdb0..6049dfb 100644 --- a/src/content/docs/reference/cli.md +++ b/src/content/docs/reference/cli.md @@ -31,31 +31,23 @@ shulkerscript build [OPTIONS] [PATH] - `PATH`: The path to the directory where the project is located. Defaults to the current directory. Options: +- `--assets ` The path to the assets directory [default: `./assets`] - `--output ` The output directory, overrides the `DATAPACK_DIR` environment variable +- `--zip` Package the output into a zip file Environment variables: - `DATAPACK_DIR` The output directory [default: `./dist`] -## package -Build and package the project at the specified path to a `.zip` file. -```bash -shulkerscript package [OPTIONS] [PATH] -``` - -- `PATH`: The path to the directory where the project is located. Defaults to the current directory. - -Options & Environment: -- Same as `build` - ## watch ```bash -shulkerscript watch [OPTIONS] [SUBCOMMAND] +shulkerscript watch [OPTIONS] [PATH] ``` -- `SUBCOMMAND`: The command to run when changes have been detected, has to be either `build` or `package` [default: `build`] +- `PATH`: The path of the project folder to watch [default: `.`] Options: - `--no-initial` Do not run the command initially - `--debounce-time ` The time to wait in ms after the last change before running the command [default: `2000`] +- `--execute ` The commands (cli subcommands or shell commands) to execute in the project when changes have been detected [multi-arg, default: `build`] ## clean Clean the output directory of the project at the specified path. @@ -66,6 +58,8 @@ shulkerscript clean [OPTIONS] [PATH] Options: - `--output ` The output directory, overrides the `DATAPACK_DIR` environment variable +- `--all` Clean all files in the output directory, not only the ones generated by shulkerscript +- `--force` Required for `--all` to prevent accidental deletion of files Environment variables: - `DATAPACK_DIR` The output directory [default: `./dist`] \ No newline at end of file