username/rf-mapper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update CLI commands to use python -m rf_mapper

Browse Source 
- Replace rf-mapper with python -m rf_mapper throughout docs
- Add note about activating venv first
- Updated: CLAUDE.md, PROJECT.md, USAGE.md, CHEATSHEET.md, HOME_ASSISTANT.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
User
2026-02-01 17:38:44 +01:00
parent 322c53d513
commit 91536860ad
5 changed files with 72 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
USAGE.md
View File

@@ -65,7 +65,7 @@ For auto-start on device boot, create `~/.termux/boot/start-rf-mapper.sh`:
termux-wake-lock
cd ~/git/rf-mapper
source venv/bin/activate
rf-mapper start
python -m rf_mapper start
```
Make it executable:
@@ -91,92 +91,97 @@ pip install -e .
source venv/bin/activate
# Run interactive scan
rf-mapper
python -m rf_mapper
# Start web server
rf-mapper start
python -m rf_mapper start
```
## CLI Commands
All commands require activating the virtual environment first:
```bash
source venv/bin/activate
```
### Scanning
```bash
# Basic scan (interactive mode)
rf-mapper
python -m rf_mapper
# Scan with location label
rf-mapper scan -l kitchen
python -m rf_mapper scan -l kitchen
# Scan WiFi only
rf-mapper scan --no-bt
python -m rf_mapper scan --no-bt
# Scan Bluetooth only
rf-mapper scan --no-wifi
python -m rf_mapper scan --no-wifi
# Use specific WiFi interface
rf-mapper scan -i wlan1
python -m rf_mapper scan -i wlan1
```
### Visualization (CLI)
```bash
# Visualize latest scan (ASCII radar + charts)
rf-mapper visualize
python -m rf_mapper visualize
# Visualize specific scan file
rf-mapper visualize -f data/scan_20240131_120000_kitchen.json
python -m rf_mapper visualize -f data/scan_20240131_120000_kitchen.json
# Analyze RF environment
rf-mapper analyze
python -m rf_mapper analyze
```
### Scan History
```bash
# List saved scans
rf-mapper list
python -m rf_mapper list
```
### Web Server
```bash
# Start web server (background daemon)
rf-mapper start
python -m rf_mapper start
# Start in foreground (for debugging)
rf-mapper start --foreground
python -m rf_mapper start --foreground
# Custom host/port
rf-mapper start -H 127.0.0.1 -p 8080
python -m rf_mapper start -H 127.0.0.1 -p 8080
# With debug mode
rf-mapper start --foreground --debug
python -m rf_mapper start --foreground --debug
# With request profiling
rf-mapper start --profile-requests
python -m rf_mapper start --profile-requests
# With request logging
rf-mapper start --log-requests
python -m rf_mapper start --log-requests
# Stop the server
rf-mapper stop
python -m rf_mapper stop
# Restart the server
rf-mapper restart
python -m rf_mapper restart
# Check server status
rf-mapper status
python -m rf_mapper status
```
### Configuration
```bash
# Show current configuration
rf-mapper config
python -m rf_mapper config
# Set GPS coordinates
rf-mapper config --set-gps 50.8585 4.3978 --save
python -m rf_mapper config --set-gps 50.8585 4.3978 --save
# Check Termux prerequisites (Android only)
rf-mapper check-termux
@@ -462,7 +467,7 @@ adb shell "settings put global settings_enable_monitor_phantom_procs false"
### Master Dashboard: Node selector not appearing
1. Verify `is_master: true` in config.yaml
2. Restart rf-mapper: `rf-mapper restart`
2. Restart rf-mapper: `python -m rf_mapper restart`
3. Check peers are registered: `curl http://localhost:5000/api/peers | jq '.peers | length'`
4. At least one peer must be registered for selector to appear