moritz
/
shulkerscript-webpage
mirror of https://github.com/moritz-hoelting/shulkerscript-webpage.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

remove package command and update watch command

This commit is contained in:
Moritz Hölting 2024-06-13 10:39:06 +02:00
parent 98654e4deb
commit 73e8492057
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/content/docs/reference/cli.md
View File

@ -31,31 +31,23 @@ shulkerscript build [OPTIONS] [PATH]
- `PATH`: The path to the directory where the project is located. Defaults to the current directory. - `PATH`: The path to the directory where the project is located. Defaults to the current directory.
Options: Options:
- `--assets <ASSETS>` The path to the assets directory [default: `./assets`]
- `--output <OUTPUT>` The output directory, overrides the `DATAPACK_DIR` environment variable - `--output <OUTPUT>` The output directory, overrides the `DATAPACK_DIR` environment variable
- `--zip` Package the output into a zip file
Environment variables: Environment variables:
- `DATAPACK_DIR` The output directory [default: `./dist`] - `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 ## watch
```bash ```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: Options:
- `--no-initial` Do not run the command initially - `--no-initial` Do not run the command initially
- `--debounce-time <DEBOUNCE_TIME>` The time to wait in ms after the last change before running the command [default: `2000`] - `--debounce-time <DEBOUNCE_TIME>` The time to wait in ms after the last change before running the command [default: `2000`]
- `--execute <COMMAND>` The commands (cli subcommands or shell commands) to execute in the project when changes have been detected [multi-arg, default: `build`]
## clean ## clean
Clean the output directory of the project at the specified path. Clean the output directory of the project at the specified path.
@ -66,6 +58,8 @@ shulkerscript clean [OPTIONS] [PATH]
Options: Options:
- `--output <OUTPUT>` The output directory, overrides the `DATAPACK_DIR` environment variable - `--output <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: Environment variables:
- `DATAPACK_DIR` The output directory [default: `./dist`] - `DATAPACK_DIR` The output directory [default: `./dist`]