gogilo/sms-parser-cli

A CLI tool to extract M-Pesa transactions from SMS XML backups

V1.05 2025-05-26 18:46 UTC

Requires

• illuminate/console: ^12.15
• symfony/console: ^7.2

Requires (Dev)

• phpunit/phpunit: ^12.1
• symfony/filesystem: ^7.2
• symfony/process: ^7.2

MIT

• Ogilo G. D. Ouma

README

A PHP-based command-line tool for parsing M-Pesa SMS backup XML files and extracting incoming transactions into a CSV file.

📦 Features

• Parses SMS backup files (e.g., from SMS Backup & Restore app)
• Extracts M-Pesa received payments from a specific sender
• Saves unique transactions to mpesa_transactions.csv
• Detects and skips duplicates
• Works with sms-*.xml files in the current directory

🚀 Installation

1. Clone the Repository

git clone https://github.com/gogilo2003/sms-parser.git
cd sms-parser

2. Install Globally via Composer

composer global config repositories.sms-parser path $(pwd)
composer global require gogilo/sms-parser:dev-main

If you push this to GitHub, you can later install it directly via:

composer global require gogilo/sms-parser

✅ Usage

In any directory with sms-*.xml files:

parse-sms "JOHN DOE"

Arguments

• "JOHN DOE" — The name of the person you're expecting M-Pesa payments from. It should appear exactly as shown in the SMS body.

📂 Output

A CSV file mpesa_transactions.csv will be created with the following columns:

• Date
• Mpesa Reference
• From Name
• From Phone
• Amount

Duplicates (based on reference code) are automatically skipped.

📘 Example

parse-sms "PETER MAINA"

Output:

Processing sms-backup-2024.xml
  Potential match found!
  MATCHED TRANSACTION:
    Ref: ABC123XYZ
    From: PETER MAINA
    Phone: [phone]
    Amount: 1,000.00
    Date: 24/04/24 at 3:40 PM

RESULTS:
- Found 1 new transactions
- Skipped 0 duplicate references
- Output saved to mpesa_transactions.csv

🔧 Requirements

• PHP 7.4+
• Composer

📄 License

MIT

🙏 Acknowledgements

Created by Ogilo G.D. Ouma
SMS format based on Safaricom M-Pesa messages