MyWealth CLI
An Overview
The MyWealth CLI is a powerful command-line tool designed to streamline the administration of the MyWealth platform. Whether you’re managing data backups, creating and updating records, generating reports or posting transactions, the MyWealth CLI offers a seamless experience to keep your platform operations efficient and optionally align data with other systems.
Key Features
Data Management
Easily backup and reconcile your data with upstream systems.
Record Handling
Create, update, validate, and delete records effortlessly.
Transaction Control
Post, reverse, and approve transactions with precision.
Comprehensive Reporting
Download data and generate reports on your transactions.
Seamless Integration
Available for Windows, Linux, and macOS, supporting both aarch64 and x86_64 architectures.
Getting Started
1. Download the Correct Version
Choose the version that matches your CPU architecture and operating system:
- Windows (x86_64)
- Linux
- macOS (Apple)
2. Setup and Installation
- Add the downloaded application to your system’s `PATH` variable.**
- Open a terminal and navigate to a directory where you have permission to create files.
3. Login to MyWealth
Log in using your MyWealth credentials
mwa login --environment <ENVIRONMENT> --tenant <TENANT> --username <USERNAME> --password <PASSWORD> 4. Explore CLI Commands
To view all available commands:
mwa --help Example Usage
Here’s how you can perform some key operations
- Download a Record Type
mwa download --environment prod --tenant <TENANT> --record_type <RECORD_TYPE> --source <SOURCE>
- Validate CSV Records
mwa validate --environment dev --tenant <TENANT> --record_type <RECORD_TYPE>
- Create Records
mwa create --environment dev --tenant <TENANT> --record_type <RECORD_TYPE>
Available Commands
- login: Authenticate with MyWealth.
- logout: End your session.
- backup: Backup your data.
- rebuild: Rebuild a record set.
- validate: Validate records before uploading.
- create: Add new records.
- update: Modify existing records.
- delete: Remove records.
- post: Submit pending transactions.
- reverse: Reverse posted transactions.
- approve: Approve pending transactions.
- download: Retrieve records from the environment.
- help: Display command information.
To help facilitate data backup we have provided a sample script to help you download your data to a target SQLite database on your local machine. The script can be modified as needed.
Options
-e, --environment: Specify the environment (`dev`, `sandbox`, `prod`).-t, --tenant: Enter your tenant identifier.-h, --help: View command-specific help.-V, --version: Check the CLI version.
For detailed documentation and troubleshooting, visit our support page or contact our support team at support@mywealth.com.