@@ -24,17 +24,60 @@ A cutting-edge WiFi-based human pose estimation system that leverages Channel St
2424
2525## 📋 Table of Contents
2626
27- 1 . [ System Architecture] ( #system-architecture )
28- 2 . [ Installation] ( #installation )
29- 3 . [ Quick Start] ( #quick-start )
30- 4 . [ Documentation] ( #documentation )
31- 5 . [ Hardware Setup] ( #hardware-setup )
32- 6 . [ Configuration] ( #configuration )
33- 7 . [ Testing] ( #testing )
34- 8 . [ Deployment] ( #deployment )
35- 9 . [ Performance Metrics] ( #performance-metrics )
36- 10 . [ Contributing] ( #contributing )
37- 11 . [ License] ( #license )
27+ 1 . [ 🚀 Key Features] ( #-key-features )
28+ 2 . [ 🏗️ System Architecture] ( #️-system-architecture )
29+ - [ Core Components] ( #core-components )
30+ 3 . [ 📦 Installation] ( #-installation )
31+ - [ Using pip (Recommended)] ( #using-pip-recommended )
32+ - [ From Source] ( #from-source )
33+ - [ Using Docker] ( #using-docker )
34+ - [ System Requirements] ( #system-requirements )
35+ 4 . [ 🚀 Quick Start] ( #-quick-start )
36+ - [ Basic Setup] ( #1-basic-setup )
37+ - [ Start the System] ( #2-start-the-system )
38+ - [ Using the REST API] ( #3-using-the-rest-api )
39+ - [ Real-time Streaming] ( #4-real-time-streaming )
40+ 5 . [ 🖥️ CLI Usage] ( #️-cli-usage )
41+ - [ Installation] ( #cli-installation )
42+ - [ Basic Commands] ( #basic-commands )
43+ - [ Configuration Commands] ( #configuration-commands )
44+ - [ Monitoring Commands] ( #monitoring-commands )
45+ - [ Examples] ( #cli-examples )
46+ 6 . [ 📚 Documentation] ( #-documentation )
47+ - [ Core Documentation] ( #-core-documentation )
48+ - [ Quick Links] ( #-quick-links )
49+ - [ API Overview] ( #-api-overview )
50+ 7 . [ 🔧 Hardware Setup] ( #-hardware-setup )
51+ - [ Supported Hardware] ( #supported-hardware )
52+ - [ Physical Setup] ( #physical-setup )
53+ - [ Network Configuration] ( #network-configuration )
54+ - [ Environment Calibration] ( #environment-calibration )
55+ 8 . [ ⚙️ Configuration] ( #️-configuration )
56+ - [ Environment Variables] ( #environment-variables )
57+ - [ Domain-Specific Configurations] ( #domain-specific-configurations )
58+ - [ Advanced Configuration] ( #advanced-configuration )
59+ 9 . [ 🧪 Testing] ( #-testing )
60+ - [ Running Tests] ( #running-tests )
61+ - [ Test Categories] ( #test-categories )
62+ - [ Mock Testing] ( #mock-testing )
63+ - [ Continuous Integration] ( #continuous-integration )
64+ 10 . [ 🚀 Deployment] ( #-deployment )
65+ - [ Production Deployment] ( #production-deployment )
66+ - [ Infrastructure as Code] ( #infrastructure-as-code )
67+ - [ Monitoring and Logging] ( #monitoring-and-logging )
68+ 11 . [ 📊 Performance Metrics] ( #-performance-metrics )
69+ - [ Benchmark Results] ( #benchmark-results )
70+ - [ Performance Optimization] ( #performance-optimization )
71+ - [ Load Testing] ( #load-testing )
72+ 12 . [ 🤝 Contributing] ( #-contributing )
73+ - [ Development Setup] ( #development-setup )
74+ - [ Code Standards] ( #code-standards )
75+ - [ Contribution Process] ( #contribution-process )
76+ - [ Code Review Checklist] ( #code-review-checklist )
77+ - [ Issue Templates] ( #issue-templates )
78+ 13 . [ 📄 License] ( #-license )
79+ 14 . [ 🙏 Acknowledgments] ( #-acknowledgments )
80+ 15 . [ 📞 Support] ( #-support )
3881
3982## 🏗️ System Architecture
4083
@@ -199,6 +242,195 @@ async def stream_poses():
199242asyncio.run(stream_poses())
200243```
201244
245+ ## 🖥️ CLI Usage
246+
247+ WiFi DensePose provides a comprehensive command-line interface for easy system management, configuration, and monitoring.
248+
249+ ### CLI Installation
250+
251+ The CLI is automatically installed with the package:
252+
253+ ``` bash
254+ # Install WiFi DensePose with CLI
255+ pip install wifi-densepose
256+
257+ # Verify CLI installation
258+ wifi-densepose --version
259+ ```
260+
261+ ### Basic Commands
262+
263+ #### Start/Stop System
264+ ``` bash
265+ # Start the WiFi DensePose system
266+ wifi-densepose start
267+
268+ # Start with custom configuration
269+ wifi-densepose start --config /path/to/config.yaml
270+
271+ # Start in development mode
272+ wifi-densepose start --dev
273+
274+ # Stop the system
275+ wifi-densepose stop
276+
277+ # Restart the system
278+ wifi-densepose restart
279+ ```
280+
281+ #### System Status
282+ ``` bash
283+ # Check system status
284+ wifi-densepose status
285+
286+ # Get detailed health information
287+ wifi-densepose health
288+
289+ # Show system information
290+ wifi-densepose info
291+ ```
292+
293+ #### Pose Data Operations
294+ ``` bash
295+ # Get latest pose data
296+ wifi-densepose pose latest
297+
298+ # Get pose history
299+ wifi-densepose pose history --hours 24
300+
301+ # Stream pose data to console
302+ wifi-densepose pose stream
303+
304+ # Export pose data
305+ wifi-densepose pose export --format json --output poses.json
306+ ```
307+
308+ ### Configuration Commands
309+
310+ #### Environment Setup
311+ ``` bash
312+ # Initialize configuration
313+ wifi-densepose init
314+
315+ # Create configuration from template
316+ wifi-densepose config create --template healthcare
317+
318+ # Validate configuration
319+ wifi-densepose config validate
320+
321+ # Show current configuration
322+ wifi-densepose config show
323+ ```
324+
325+ #### Hardware Configuration
326+ ``` bash
327+ # List available WiFi interfaces
328+ wifi-densepose hardware list-interfaces
329+
330+ # Test hardware connectivity
331+ wifi-densepose hardware test
332+
333+ # Calibrate environment
334+ wifi-densepose calibrate --duration 10 --environment room_001
335+
336+ # Show hardware status
337+ wifi-densepose hardware status
338+ ```
339+
340+ ### Monitoring Commands
341+
342+ #### Real-time Monitoring
343+ ``` bash
344+ # Monitor system performance
345+ wifi-densepose monitor
346+
347+ # Monitor pose detection in real-time
348+ wifi-densepose monitor poses
349+
350+ # Monitor system logs
351+ wifi-densepose logs --follow
352+
353+ # Monitor specific component
354+ wifi-densepose monitor --component csi_processor
355+ ```
356+
357+ #### Analytics and Reports
358+ ``` bash
359+ # Generate analytics report
360+ wifi-densepose analytics report --period 24h
361+
362+ # Show fall detection events
363+ wifi-densepose analytics falls --since yesterday
364+
365+ # Export system metrics
366+ wifi-densepose metrics export --format csv
367+ ```
368+
369+ ### CLI Examples
370+
371+ #### Complete Setup Workflow
372+ ``` bash
373+ # 1. Initialize new environment
374+ wifi-densepose init --environment healthcare
375+
376+ # 2. Configure hardware
377+ wifi-densepose hardware setup --interface wlan0
378+
379+ # 3. Calibrate environment
380+ wifi-densepose calibrate --duration 15
381+
382+ # 4. Start system
383+ wifi-densepose start
384+
385+ # 5. Monitor in real-time
386+ wifi-densepose monitor poses
387+ ```
388+
389+ #### Development Workflow
390+ ``` bash
391+ # Start in development mode with mock data
392+ wifi-densepose start --dev --mock-hardware
393+
394+ # Run tests
395+ wifi-densepose test
396+
397+ # Check code quality
398+ wifi-densepose lint
399+
400+ # Generate documentation
401+ wifi-densepose docs generate
402+ ```
403+
404+ #### Production Deployment
405+ ``` bash
406+ # Deploy to production
407+ wifi-densepose deploy --environment production
408+
409+ # Check deployment status
410+ wifi-densepose deploy status
411+
412+ # Scale system
413+ wifi-densepose scale --replicas 3
414+
415+ # Update system
416+ wifi-densepose update --version 1.2.0
417+ ```
418+
419+ #### Troubleshooting
420+ ``` bash
421+ # Run system diagnostics
422+ wifi-densepose diagnose
423+
424+ # Check hardware connectivity
425+ wifi-densepose hardware test --verbose
426+
427+ # Validate configuration
428+ wifi-densepose config validate --strict
429+
430+ # Reset to defaults
431+ wifi-densepose reset --confirm
432+ ```
433+
202434## 📚 Documentation
203435
204436Comprehensive documentation is available to help you get started and make the most of WiFi-DensePose:
0 commit comments