Tools and helper scripts for managing Needle Engine projects
TODO: update readme with docs for each script TODO: add https://github.com/75lb/command-line-usage
-
tool:stop-processes
- invoke to stop running processes with commandline arguments matching a patternnpm run tool:stop-processes -- --pattern \"*my-regex"
-
tool:zip
- invoke to zip a directory or a single file, optionally provide a target directory.node_module
folders are ignored by default.npm run tool:zip "path/to/file/or/directory"
npm run tool:zip -- --source "path/to/file/or/directory" --target "path/to/file/or/directory"
-
tool:upload-bugreport
- upload a bug report to the needle backend (requires env variables to be set)-
file
path to file or directory (will be zipped automatically if necessary) -
source
(optional) name of the tool that triggered the run -
user
(optional) meta information about the user -
url
(optional) backend url e.g.http://localhost:8080/api/v1/bugreport
for local development
-
-
tool:publish-to-github-pages
- deploy a folder to github pages.-
directory
a directory with either the already built content or a needle web project (containingneedle-config.json
) -
repository
* optional, when used this is the github pages repository, otherwise it will try to find the repo to deploy to in the provided directory parent hierarchy
-
-
tool:git-clone
- clone a remote repository. If no git is installed the repository will be downloaded-
url
a github url. Can contain a branch viagithub.com/<user>/<name>/tree/<branch>
orgithub.com/<user>/<name>/commit/<commit>
-
targetDir
the target directory to clone into
-
-
tool:share
-npm run tool:share -- --id "test" --directory "C:\path\to\assets" --endpoint http://localhost:8081 --access-token "<your_token>" --open