GrowERP CLI Utilities #

A command line utility for GrowERP installation, import/export, and package management.

Installation #

Activate local version:

dart pub global activate --source path ~/growerp/flutter/packages/growerp

Activate public version:

dart pub global activate growerp

Subcommands #

help #

Display detailed help information for all available commands.

growerp help

install #

Installs the complete GrowERP system:

1. Clone the repository from GitHub into the local ~/growerp directory
2. Start the backend and chat server
3. Activate the dart melos global command
4. Build the Flutter system
5. The 'admin' package can now be started with flutter run

growerp install

Flags:

• -dev — Use the development branch instead of master
• -d <path> — Target directory (default: ~/growerp)

import #

Upload data (ledger/glAccount, customers, products, etc.) from CSV files into GrowERP.

growerp import -i <inputDir> -u <email> -p <password> [options]

Parameters:

Example:

growerp import -i growerpOutput -u admin@example.com -p secret123 -n "My Company" -c USD

export #

Export company-related information to CSV files. (Under development)

growerp export -u <email> -p <password> [options]

Parameters:

finalize #

Finalize the import process by:

1. Complete all documents posted in the ledger
2. Complete orders with completed invoices
3. Approve invoices and complete payments
4. Process shipments
5. Close past time periods

growerp finalize -u <email> -p <password> [options]

Parameters:

createPackage #

Create a new GrowERP package with both Flutter frontend and Moqui backend components.

growerp createPackage <name> [options]

Parameters:

Creates:

• flutter/packages/growerp_<name>/ — Flutter frontend package
• moqui/runtime/component/growerp-<name>/ — Moqui backend component

Example:

growerp createPackage inventory

exportPackage #

Export an existing GrowERP package as a zip archive for distribution or backup.

growerp exportPackage <packageName> [options]

Parameters:

Example:

growerp exportPackage growerp_inventory -o ~/backups

importPackage #

Import a GrowERP package from a zip archive. Automatically adds the package to melos.yaml.

growerp importPackage <archivePath>

Parameters:

Example:

growerp importPackage ~/downloads/growerp_inventory.zip

convertToCsv Command #

A separate utility to convert exported CSV/ODS/XLSX files from other systems to the GrowERP CSV format.

convertToCsv <inputDir> [fileType]

Parameters:

• <inputDir> — Directory containing the source files
• [fileType] — Optional: specific file type to convert

Example:

convertToCsv inputDir transaction

Creates a growerpOutput directory with the converted files.

Complete Conversion Workflow #

1. Export files from the old system and place them in a single directory
2. Create images directory (if importing images): create an images/ folder and images.csv file
3. Configure conversion rules in the convert_to_csv program:
   • Specify file names in getFileNames function
   • Specify file-wide changes in convertFile function
   • Specify column mappings in convertRow function
4. Convert the files:

   dart pub global activate --source path ~/growerp/flutter/packages/growerp
   dart pub global run growerp:convertToCsv inputDir -f fileType -start yyyy/mm/dd -end yyyy/mm/dd
   

5. Import into GrowERP:

   growerp import -i growerpOutput -u username -p password
   

6. Finalize the import:

   growerp finalize -u username -p password
   

Pre-Import Checklist #

Before running import:

1. Pause the 'recalculate account summaries' job

Before running finalize:

1. Disable accounting SECA by modifying files as listed in initstart.sh under 'DISABLE_SECA'

After finalize:

1. Re-enable the recalculate job
2. Restore SECA files