sandstone-cli

The CLI for Sandstone - the data pack creation library.

• Usage
• Commands

Usage

$ npm install -g sandstone-cli
$ sand COMMAND
running command...
$ sand (-v|--version|version)
sandstone-cli/0.3.0 win32-x64 node-v14.15.0
$ sand --help [COMMAND]
USAGE
  $ sand COMMAND
...

Commands

• sand build PATH CONFIG-PATH
• sand create PROJECT-NAME
• sand help [COMMAND]
• sand update
• sand watch PATH CONFIG-PATH

sand build PATH CONFIG-PATH

Build the datapack. ⛏

USAGE
  $ sand build PATH CONFIG-PATH

ARGUMENTS
  PATH         [default: ./src] Path of the folder containing source files.
  CONFIG-PATH  [default: .] Path of the sandstone.config.ts folder.

OPTIONS
  -d, --dry                      Do not save the datapack. Mostly useful with `verbose`.
  -h, --help                     show CLI help
  -v, --verbose                  Log all resulting resources: functions, advancements...
  --description=description      Description of the data pack. Override the value specified in the configuration file.
  --formatVersion=formatVersion  Pack format version. Override the value specified in the configuration file.
  --fullTrace                    Show the full stack trace on errors.
  --minecraftPath=minecraftPath  Path of the .minecraft folder. Override the value specified in the configuration file.
  --name=name                    Name of the data pack. Override the value specified in the configuration file.
  --namespace=namespace          The default namespace. Override the value specified in the configuration file.

  --path=path                    The path to save the data pack at. Override the value specified in the configuration
                                 file.

  --root                         Save the data pack in the `.minecraft/datapacks` folder. Override the value specified
                                 in the configuration file.

  --world=world                  The world to save the data pack in. Override the value specified in the configuration
                                 file.

EXAMPLES
  $ sand build
  $ sand build --verbose
  $ sand build --verbose --dry

See code: src/commands/build.ts

sand create PROJECT-NAME

Create a new Sandstone project.

USAGE
  $ sand create PROJECT-NAME

ARGUMENTS
  PROJECT-NAME  Name of the project folder. This is not the name of the data pack.

OPTIONS
  -d, --datapack-name=datapack-name  The name of the data pack.
  -h, --help                         show CLI help
  -n, --namespace=namespace          The default namespace that will be used.
  -p, --custom-path=custom-path      The path to save the data pack at. Not compatible with --save-root and --world.

  -r, --save-root                    Save the data pack in the .minecraft/datapacks folder. Not compatible with --world
                                     and --custom-path.

  -w, --world=world                  The world to save the data pack in. Not compatible with --save-root and
                                     --custom-path.

  --npm                              Use npm.

  --yarn                             Use yarn instead of npm.

EXAMPLE
  $ sand create my-datapack

See code: src/commands/create.ts

sand help [COMMAND]

display help for sand

USAGE
  $ sand help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

sand update

Update Sandstone & Sandstone-CLI.

USAGE
  $ sand update

OPTIONS
  -h, --help   show CLI help
  --cli        Update the Sandstone CLI without asking.
  --npm        Use npm to install the updates.
  --sandstone  Update the current Sandstone version without asking.
  --skip       Skip all interactive prompts and refuse them.
  --yarn       Use yarn to install the updates.

EXAMPLES
  $ sand update
  $ sand update --cli
  $ sand update --sandstone
  $ sand update --cli --sandstone --skip

See code: src/commands/update.ts

sand watch PATH CONFIG-PATH

Build the datapack, and rebuild it on file change. ⛏

USAGE
  $ sand watch PATH CONFIG-PATH

ARGUMENTS
  PATH         [default: ./src] Path of the folder containing source files.
  CONFIG-PATH  [default: .] Path of the sandstone.config.ts folder.

OPTIONS
  -d, --dry                      Do not save the datapack. Mostly useful with `verbose`.
  -h, --help                     show CLI help
  -v, --verbose                  Log all resulting resources: functions, advancements...
  --description=description      Description of the data pack. Override the value specified in the configuration file.
  --formatVersion=formatVersion  Pack format version. Override the value specified in the configuration file.
  --fullTrace                    Show the full stack trace on errors.
  --minecraftPath=minecraftPath  Path of the .minecraft folder. Override the value specified in the configuration file.
  --name=name                    Name of the data pack. Override the value specified in the configuration file.
  --namespace=namespace          The default namespace. Override the value specified in the configuration file.

  --path=path                    The path to save the data pack at. Override the value specified in the configuration
                                 file.

  --root                         Save the data pack in the `.minecraft/datapacks` folder. Override the value specified
                                 in the configuration file.

  --world=world                  The world to save the data pack in. Override the value specified in the configuration
                                 file.

EXAMPLES
  $ sand watch
  $ sand watch --verbose
  $ sand watch --verbose --dry

See code: src/commands/watch.ts