CLI Tools
Raspi-Sump provides several command line tools installed with the package.
rsump
The main monitoring daemon. This is managed by systemd and does not normally need to be run manually.
rsump
Reads the reading_interval from raspisump.conf:
- If
reading_interval = 0— takes a single reading and exits - Otherwise — takes readings continuously at the configured interval
The raspisump systemd service runs this command automatically.
rsumplog
Query water level readings from the database.
rsumplog [OPTIONS]
Options
| Option | Description |
|---|---|
| (none) | Show today's readings (default) |
--today |
Show today's readings |
--date YYYY-MM-DD |
Show readings for a specific date |
--last N |
Show the last N readings |
--cycles |
Show pump cycle count (requires cycle detection enabled) |
Examples
# Today's readings
rsumplog
# Readings for a specific date
rsumplog --date 2026-03-15
# Last 10 readings
rsumplog --last 10
# Pump cycles for today (experimental)
rsumplog --cycles
# Pump cycles for a specific date (experimental)
rsumplog --cycles --date 2026-03-15
!!! note "Cycle detection"
--cycles requires cycle_detection = yes in the [experimental]
section of raspisump.conf. See Configuration for details.
rsumpimport
Import historical CSV files from Raspi-Sump 1.x into the SQLite database.
rsumpimport --dir PATH --unit metric|imperial
rsumpimport --file FILE [FILE ...] --unit metric|imperial
Options
| Option | Description |
|---|---|
--dir PATH |
Directory containing waterlevel-*.csv files |
--file FILE ... |
One or more specific CSV files to import |
--unit |
Unit system the CSV data was recorded in (metric or imperial) |
Examples
# Import all CSV files from a directory
rsumpimport --dir ~/raspi-sump-backup/ --unit metric
# Import specific files
rsumpimport --file waterlevel-2025-01-01.csv waterlevel-2025-01-02.csv --unit imperial
Duplicate entries are skipped automatically — safe to run more than once.
alerttest
Send a test alert notification using the current configuration.
alerttest
Tests whichever alert type is configured (alert_type = 1 for email,
alert_type = 2 for Mastodon). Useful for verifying credentials and
connectivity after initial setup or after changing alert settings.
rsumpsupport
Generate a support information file for bug reports.
rsumpsupport
Dumps system and raspisump environment information to a file in
/var/lib/raspi-sump/support/. Attach this file when reporting issues
in the issue tracker.
!!! note The support file does not contain passwords or credentials.