Command-Line Interface (CLI)

You can obtain the grouparoo CLI via NPM with npm install -g grouparoo.

Project Maintenance

• 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.json or add new ones. This is equivalent to npm install [package].

Configuration

• grouparoo generate [options] [template] [id] - Generate a config file for an new object (App, Source, Property, Destination, etc) from a template.
• 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 start and grouparoo run as well. Optionally disable checking with remote Apps.

Development, Testing and Deployment

• grouparoo status - Get the status of your grouparoo cluster.
• grouparoo sync <profile> (--no-export) - Import and Export 1 profile fully and output a snapshot.
• grouparoo run (--web) (--reset) (--no-export) - Run the application and stop after every Profile has been imported and exported as needed.
• grouparoo start - Run the application. Keep checking for new and updated Profiles. This is equivalent to npm start.
• grouparoo reset - Reset your cluster removing some or all of your data.
• grouparoo console - (developer) Get an interactive cli console with the api object in scope.

Example

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 .

# create an App, Source, and Properties
grouparoo generate postgres:app data_warehouse
grouparoo generate postgres:table:source users_table --parent data_warehouse
grouparoo generate postgres:table:property email --parent users_table
grouparoo generate postgres:table:property first_name --parent users_table
grouparoo generate postgres:table:property last_name --parent users_table

# 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