CLI: Setup & Maintenance

Last Updated: 2021-02-08

grouparoo init

$ grouparoo init <path>

Initialize a new Grouparoo project. Use "." for this directory.

Options:
-f, --force overwrite the generated files if they already exist
-h, --help display help for command

grouparoo update

$ grouparoo update

Upgrade the NPM packages in this Grouparoo project

Options:
-h, --help display help for command

grouparoo install

$ grouparoo install [package]

Install a grouparoo plugin (via npm install) and enable it. Use package@version for a specific version or tag

Options:
-h, --help display help for command

Under the hood, the Install command is using npm to install packages from the npm repository and enable them in the grouparoo.plugins section of your project's package.json. You can learn more about plugins here.