This is a CLI to interact with Rayhunter. It was built with the intent of giving myself the ability to automate alerting and recording management on a Rayhunter that is not-mobile (ie., it is plugged in 24/7 in my attic). If you too wish to script or otherwise automate using your Rayhunter, you might find this to be helpful!

Important: This is a personal side-project, and has no affiliation with or endorsement from the Rayhunter project, or the EFF. It is entirely unofficial, and without warranty.

Currently implemented:

• alerts from live analysis, with severity-based exit codes
• recording list/start/stop/delete/download
• analysis report for named or active recordings
• analysis queue status and triggering analysis runs
• system stats and raw log output
• device clock show and sync
• config show/set/test-notification
• JSON output mode for scriptable commands
• optional basic auth and config file support
• debug utilities (display-state)

gem install raygatherer

Requires Ruby >= 3.2.

git clone https://github.com/mjstallard/raygatherer.git
cd raygatherer
bundle install
make build
make install

Or build and install the gem directly:

gem build raygatherer.gemspec
gem install ./raygatherer-*.gem

Check CLI help:

raygatherer --help

Check live alerts:

raygatherer --host http://192.168.1.1 alerts

Check live alerts as JSON:

raygatherer --host http://192.168.1.1 --json alerts

List recordings:

raygatherer --host http://192.168.1.1 recording list

Download a recording:

raygatherer --host http://192.168.1.1 recording download 1738950000

Show analysis report for a recording:

raygatherer --host http://192.168.1.1 analysis report 1738950000

Show analysis report for the active recording:

raygatherer --host http://192.168.1.1 analysis report --live

Show analysis queue status:

raygatherer --host http://192.168.1.1 analysis status

Show system stats:

raygatherer --host http://192.168.1.1 stats

These can be used with any command:

• --host HOST (required unless provided in config file)
• --basic-auth-user USER
• --basic-auth-password PASS
• --verbose
• --json (only applies to commands that support JSON output)

By default, config is loaded from:

• ~/.config/raygatherer/config.yml
• or $XDG_CONFIG_HOME/raygatherer/config.yml if XDG_CONFIG_HOME is set

Supported keys:

• host
• basic_auth_user
• basic_auth_password
• json
• verbose

CLI flags always override config values.

Example:

host: http://192.168.1.1
basic_auth_user: admin
basic_auth_password: replace-me
json: false
verbose: false

Main commands:

• alerts
• recording list
• recording start
• recording stop
• recording download <name> [--qmdl|--pcap|--zip] [--download-dir DIR|--save-as PATH]
• recording delete <name> | --all [--force]
• analysis status
• analysis run <name> | --all
• analysis report <name> | --live
• time show
• time sync
• config show
• config set (reads JSON from stdin)
• config test-notification
• stats
• log
• debug display-state <recording|paused|warning> [--severity low|medium|high]

For command-specific help:

raygatherer COMMAND --help

Examples:

raygatherer alerts --help
raygatherer recording download --help
raygatherer analysis run --help

alerts returns severity-based codes so shell scripts can react:

• 0: no alerts
• 1: error
• 10: low severity alert
• 11: medium severity alert
• 12: high severity alert

Example:

raygatherer --host http://192.168.1.1 alerts
code=$?
[ "$code" -ge 11 ] && echo "medium or high alert"

Commands that support --json return machine-readable output to stdout. This is intended for jq and/or scripts.

Example:

raygatherer --host http://192.168.1.1 --json config show | jq '.analyzers'

Install dependencies:

bundle install

Run tests:

make test

Run linter:

make lint

Build gem:

make build

• This tool can send credentials over plaintext via HTTP if you point it at http://....
• Config files may contain credentials. Restrict permissions appropriately.
• This is an unofficial tool. Verify behavior in your environment before relying on it.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Raygatherer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.