home-lab/packages/lab_tool_howto.md
Geir Okkenhaug Jerstad cc735b3497 feat: Complete migration to GNU Guile Scheme with MCP integration
Major project milestone: Successfully migrated home lab management tool from Bash to GNU Guile Scheme

## Completed Components 
- **Project Foundation**: Complete directory structure (lab/, mcp/, utils/)
- **Working CLI Tool**: Functional home-lab-tool.scm with command parsing
- **Development Environment**: NixOS flake.nix with Guile, JSON, SSH, WebSocket libraries
- **Core Utilities**: Logging, configuration, SSH utilities with error handling
- **Module Architecture**: Comprehensive lab modules and MCP server foundation
- **TaskMaster Integration**: 25-task roadmap with project management
- **Testing & Validation**: Successfully tested in nix develop environment

## Implementation Highlights
- Functional programming patterns with immutable data structures
- Proper error handling and recovery mechanisms
- Clean module separation with well-defined interfaces
- Working CLI commands: help, status, deploy (with parsing)
- Modular Guile architecture ready for expansion

## Project Structure
- home-lab-tool.scm: Main CLI entry point (working)
- utils/: logging.scm, config.scm, ssh.scm (ssh needs syntax fixes)
- lab/: core.scm, machines.scm, deployment.scm, monitoring.scm
- mcp/: server.scm foundation for VS Code integration
- flake.nix: Working development environment

## Next Steps
1. Fix SSH utilities syntax errors for real connectivity
2. Implement actual infrastructure status checking
3. Complete MCP server JSON-RPC protocol
4. Develop VS Code extension with MCP client

This represents a complete rewrite maintaining compatibility while adding:
- Better error handling and maintainability
- MCP server for AI/VS Code integration
- Modular architecture for extensibility
- Comprehensive project management with TaskMaster

The Bash-to-Guile migration provides a solid foundation for advanced
home lab management with modern tooling and AI integration.
2025-06-15 22:17:47 +02:00

89 lines
2.3 KiB
Markdown

# Lab Tool Quick Reference
**Home lab infrastructure management and deployment tool**
## 🚀 Quick Commands
```bash
lab status # Check all machines
lab deploy-rs sleeper-service # Deploy with safety
lab hybrid-update all # Update everything
```
## 📋 Status & Monitoring
```bash
lab status # Basic connectivity check
lab status -v # Verbose SSH debugging
```
**Output**: ✅ Online | ⚠️ Unreachable | Connection method shown
## 🔄 Deployment Methods
### Modern (Recommended)
```bash
lab deploy-rs <machine> # Safe deployment with auto-rollback
lab deploy-rs <machine> --dry-run # Test without applying
```
### Hybrid (Best for Updates)
```bash
lab hybrid-update <machine> # Update packages + deploy safely
lab hybrid-update all # Update all machines
lab hybrid-update all --dry-run # Test updates first
```
### Legacy (Fallback)
```bash
lab deploy <machine> boot # Deploy for next boot
lab deploy <machine> switch # Deploy and activate now
lab deploy <machine> test # Temporary deployment
```
## 🔧 Maintenance
```bash
lab update-flake # Update package versions
```
## 🏠 Machines
- **congenital-optimist** - Local workstation
- **sleeper-service** - File server (NFS, ZFS)
- **grey-area** - Services host (Forgejo, Jellyfin, Ollama)
- **reverse-proxy** - Edge gateway (VPS)
## ⚡ Examples
```bash
# Daily workflow
lab status # Check infrastructure
lab hybrid-update sleeper-service # Update file server
lab deploy-rs grey-area --dry-run # Test config changes
# Emergency
lab deploy sleeper-service boot # Fallback deployment
lab status -v # Debug connectivity
# Bulk operations
lab hybrid-update all --dry-run # Test all updates
lab hybrid-update all # Apply all updates
```
## 🛡️ Safety Features
- **Auto-rollback**: Failed deployments revert automatically
- **Health checks**: Validates services before committing
- **Dry-run mode**: Test changes without applying
- **Timeouts**: Prevents hanging deployments
## 💡 Tips
- Use `hybrid-update` for regular maintenance
- Always test with `--dry-run` first for bulk operations
- `deploy-rs` provides better safety than legacy method
- Check `lab status` before deployments