Command-Line Interface (CLI)Last Updated: 2022-02-02
You can obtain the grouparoo CLI via NPM with
npm install -g grouparoo.
grouparoo init [dir]- Create a new Grouparoo project.
grouparoo update- Upgrade all Grouparoo packages to the latest versions.
grouparoo install [package]- Install packages defined in your
package.jsonor add new ones. This is equivalent to
npm install [package].
grouparoo config- Starts the UI application to manage your config files
grouparoo validate (--local)- Test and validate your code config. Doesn't write changes to the database. Optionally disable checking with remote Apps.
grouparoo apply (--local)- Apply config changes to the database. This also happens automatically with
grouparoo runas well. Optionally disable checking with remote Apps.
grouparoo status- Get the status of your grouparoo cluster.
grouparoo sync <record> (--no-export)- Import and Export 1 Record fully and output a snapshot.
grouparoo run (--web) (--reset) (--no-export)- Run the application and stop after every Record has been imported and exported as needed.
grouparoo start- Run the application. Keep checking for new and updated Records. This is equivalent to
grouparoo reset- Reset your cluster removing some or all of your data.
grouparoo console- (developer) Get an interactive cli console with the
apiobject in scope.
If you were creating a new Grouparoo project, you might:
# install the grouparoo CLI npm install -g grouparoo # initialize the project (in a new directory) grouparoo init . # configure the project grouparoo config # check out config files grouparoo validate grouparoo apply # start the application grouparoo start # and you can visit http://localhost:3000 to view the dashboard and watch your data import