Skip to content

Commit 7b5df5c

Browse files
committed
updates
1 parent 6dd89f2 commit 7b5df5c

File tree

11 files changed

+713
-141
lines changed

11 files changed

+713
-141
lines changed

README.md

Lines changed: 161 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,14 @@ system.stop()
213213
# Start the API server
214214
wifi-densepose start
215215

216-
# Or using Python
217-
python -m wifi_densepose.main
216+
# Start with custom configuration
217+
wifi-densepose -c /path/to/config.yaml start
218+
219+
# Start with verbose logging
220+
wifi-densepose -v start
221+
222+
# Check server status
223+
wifi-densepose status
218224
```
219225

220226
The API will be available at `http://localhost:8000`
@@ -255,180 +261,229 @@ The CLI is automatically installed with the package:
255261
pip install wifi-densepose
256262

257263
# Verify CLI installation
258-
wifi-densepose --version
264+
wifi-densepose --help
265+
wifi-densepose version
259266
```
260267

261268
### Basic Commands
262269

263-
#### Start/Stop System
264-
```bash
265-
# Start the WiFi DensePose system
266-
wifi-densepose start
270+
The WiFi-DensePose CLI provides the following commands:
267271

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
272+
```bash
273+
wifi-densepose [OPTIONS] COMMAND [ARGS]...
274+
275+
Options:
276+
-c, --config PATH Path to configuration file
277+
-v, --verbose Enable verbose logging
278+
--debug Enable debug mode
279+
--help Show this message and exit.
280+
281+
Commands:
282+
config Configuration management commands.
283+
db Database management commands.
284+
start Start the WiFi-DensePose API server.
285+
status Show the status of the WiFi-DensePose API server.
286+
stop Stop the WiFi-DensePose API server.
287+
tasks Background task management commands.
288+
version Show version information.
279289
```
280290

281-
#### System Status
291+
#### Server Management
282292
```bash
283-
# Check system status
284-
wifi-densepose status
293+
# Start the WiFi-DensePose API server
294+
wifi-densepose start
285295

286-
# Get detailed health information
287-
wifi-densepose health
296+
# Start with custom configuration
297+
wifi-densepose -c /path/to/config.yaml start
288298

289-
# Show system information
290-
wifi-densepose info
291-
```
299+
# Start with verbose logging
300+
wifi-densepose -v start
292301

293-
#### Pose Data Operations
294-
```bash
295-
# Get latest pose data
296-
wifi-densepose pose latest
302+
# Start with debug mode
303+
wifi-densepose --debug start
297304

298-
# Get pose history
299-
wifi-densepose pose history --hours 24
305+
# Check server status
306+
wifi-densepose status
300307

301-
# Stream pose data to console
302-
wifi-densepose pose stream
308+
# Stop the server
309+
wifi-densepose stop
303310

304-
# Export pose data
305-
wifi-densepose pose export --format json --output poses.json
311+
# Show version information
312+
wifi-densepose version
306313
```
307314

308315
### Configuration Commands
309316

310-
#### Environment Setup
317+
#### Configuration Management
311318
```bash
312-
# Initialize configuration
313-
wifi-densepose init
319+
# Configuration management commands
320+
wifi-densepose config [SUBCOMMAND]
314321

315-
# Create configuration from template
316-
wifi-densepose config create --template healthcare
322+
# Examples:
323+
# Show current configuration
324+
wifi-densepose config show
317325

318-
# Validate configuration
326+
# Validate configuration file
319327
wifi-densepose config validate
320328

321-
# Show current configuration
322-
wifi-densepose config show
329+
# Create default configuration
330+
wifi-densepose config init
331+
332+
# Edit configuration
333+
wifi-densepose config edit
323334
```
324335

325-
#### Hardware Configuration
336+
#### Database Management
326337
```bash
327-
# List available WiFi interfaces
328-
wifi-densepose hardware list-interfaces
338+
# Database management commands
339+
wifi-densepose db [SUBCOMMAND]
329340

330-
# Test hardware connectivity
331-
wifi-densepose hardware test
341+
# Examples:
342+
# Initialize database
343+
wifi-densepose db init
332344

333-
# Calibrate environment
334-
wifi-densepose calibrate --duration 10 --environment room_001
345+
# Run database migrations
346+
wifi-densepose db migrate
335347

336-
# Show hardware status
337-
wifi-densepose hardware status
338-
```
348+
# Check database status
349+
wifi-densepose db status
339350

340-
### Monitoring Commands
351+
# Backup database
352+
wifi-densepose db backup
341353

342-
#### Real-time Monitoring
354+
# Restore database
355+
wifi-densepose db restore
356+
```
357+
358+
#### Background Tasks
343359
```bash
344-
# Monitor system performance
345-
wifi-densepose monitor
360+
# Background task management commands
361+
wifi-densepose tasks [SUBCOMMAND]
362+
363+
# Examples:
364+
# List running tasks
365+
wifi-densepose tasks list
346366

347-
# Monitor pose detection in real-time
348-
wifi-densepose monitor poses
367+
# Start background tasks
368+
wifi-densepose tasks start
349369

350-
# Monitor system logs
351-
wifi-densepose logs --follow
370+
# Stop background tasks
371+
wifi-densepose tasks stop
352372

353-
# Monitor specific component
354-
wifi-densepose monitor --component csi_processor
373+
# Check task status
374+
wifi-densepose tasks status
355375
```
356376

357-
#### Analytics and Reports
358-
```bash
359-
# Generate analytics report
360-
wifi-densepose analytics report --period 24h
377+
### Command Examples
361378

362-
# Show fall detection events
363-
wifi-densepose analytics falls --since yesterday
379+
#### Complete CLI Reference
380+
```bash
381+
# Show help for main command
382+
wifi-densepose --help
383+
384+
# Show help for specific command
385+
wifi-densepose start --help
386+
wifi-densepose config --help
387+
wifi-densepose db --help
388+
389+
# Use global options with commands
390+
wifi-densepose -v status # Verbose status check
391+
wifi-densepose --debug start # Start with debug logging
392+
wifi-densepose -c custom.yaml start # Start with custom config
393+
```
364394

365-
# Export system metrics
366-
wifi-densepose metrics export --format csv
395+
#### Common Usage Patterns
396+
```bash
397+
# Basic server lifecycle
398+
wifi-densepose start # Start the server
399+
wifi-densepose status # Check if running
400+
wifi-densepose stop # Stop the server
401+
402+
# Configuration management
403+
wifi-densepose config show # View current config
404+
wifi-densepose config validate # Check config validity
405+
406+
# Database operations
407+
wifi-densepose db init # Initialize database
408+
wifi-densepose db migrate # Run migrations
409+
wifi-densepose db status # Check database health
410+
411+
# Task management
412+
wifi-densepose tasks list # List background tasks
413+
wifi-densepose tasks status # Check task status
414+
415+
# Version and help
416+
wifi-densepose version # Show version info
417+
wifi-densepose --help # Show help message
367418
```
368419

369420
### CLI Examples
370421

371422
#### Complete Setup Workflow
372423
```bash
373-
# 1. Initialize new environment
374-
wifi-densepose init --environment healthcare
424+
# 1. Check version and help
425+
wifi-densepose version
426+
wifi-densepose --help
375427

376-
# 2. Configure hardware
377-
wifi-densepose hardware setup --interface wlan0
428+
# 2. Initialize configuration
429+
wifi-densepose config init
378430

379-
# 3. Calibrate environment
380-
wifi-densepose calibrate --duration 15
431+
# 3. Initialize database
432+
wifi-densepose db init
381433

382-
# 4. Start system
434+
# 4. Start the server
383435
wifi-densepose start
384436

385-
# 5. Monitor in real-time
386-
wifi-densepose monitor poses
437+
# 5. Check status
438+
wifi-densepose status
387439
```
388440

389441
#### Development Workflow
390442
```bash
391-
# Start in development mode with mock data
392-
wifi-densepose start --dev --mock-hardware
443+
# Start with debug logging
444+
wifi-densepose --debug start
393445

394-
# Run tests
395-
wifi-densepose test
446+
# Use custom configuration
447+
wifi-densepose -c dev-config.yaml start
396448

397-
# Check code quality
398-
wifi-densepose lint
449+
# Check database status
450+
wifi-densepose db status
399451

400-
# Generate documentation
401-
wifi-densepose docs generate
452+
# Manage background tasks
453+
wifi-densepose tasks start
454+
wifi-densepose tasks list
402455
```
403456

404-
#### Production Deployment
457+
#### Production Workflow
405458
```bash
406-
# Deploy to production
407-
wifi-densepose deploy --environment production
459+
# Start with production config
460+
wifi-densepose -c production.yaml start
408461

409-
# Check deployment status
410-
wifi-densepose deploy status
462+
# Check system status
463+
wifi-densepose status
411464

412-
# Scale system
413-
wifi-densepose scale --replicas 3
465+
# Manage database
466+
wifi-densepose db migrate
467+
wifi-densepose db backup
414468

415-
# Update system
416-
wifi-densepose update --version 1.2.0
469+
# Monitor tasks
470+
wifi-densepose tasks status
417471
```
418472

419473
#### Troubleshooting
420474
```bash
421-
# Run system diagnostics
422-
wifi-densepose diagnose
475+
# Enable verbose logging
476+
wifi-densepose -v status
423477

424-
# Check hardware connectivity
425-
wifi-densepose hardware test --verbose
478+
# Check configuration
479+
wifi-densepose config validate
426480

427-
# Validate configuration
428-
wifi-densepose config validate --strict
481+
# Check database health
482+
wifi-densepose db status
429483

430-
# Reset to defaults
431-
wifi-densepose reset --confirm
484+
# Restart services
485+
wifi-densepose stop
486+
wifi-densepose start
432487
```
433488

434489
## 📚 Documentation

0 commit comments

Comments
 (0)