项目介绍
🏠 Home Assistant Cursor 集成
一个带有AI助手、MCP集成、SSH和SAMBA的专业Home Assistant开发环境。
✨ 特性
- 🤖 AI驱动 - 通过Cursor中的MCP管理设备
- 🔬 智能审计 - 对系统进行深入分析并提供建议
- 📊 配置分析器 - 依赖图、复杂度分析、版本差异
- 🔧 SSH/SAMBA - 直接访问配置
- 💾 自动备份 - 安全部署并支持回滚
- ⚡ 优化 - 节省高达30%的供暖费用
- 🔒 安全 - 提交前自动检查数据泄露
- 📚 文档 - 包含示例的完整文档
🚀 快速开始
# 1. 安装（仅需一次）
./scripts/setup.sh
setup.sh 设置的内容：
- ✅ 系统包（SSH、CIFS、Git、netcat）
- ✅ Python包（yamllint、pyyaml、requests）
- ✅ mcp-proxy - Home Assistant的MCP服务器
- ✅ 提交前钩子（提交前自动检查）
- ✅ 连接到HA的SSH密钥
- ✅ 所有脚本的权限
# 2. 主菜单（所有控制都在这里！）
./ha
或者直接：
./scripts/configure.sh # 配置模式
./scripts/mount.sh # 挂载
./scripts/validate_yaml.sh # 验证YAML
code config/ # 编辑
./scripts/deploy.sh # 部署
📂 结构
~/HASSio/
├── README.md # 项目概述
├── docs/ # 开发者文档
│ ├── setup/ # 安装和配置
│ ├── guides/ # 指南
│ ├── reference/ # 参考手册
│ ├── examples/ # 示例
│ └── analyzers/ # 📊 配置分析器
├── scripts/ # 所有脚本
│ ├── setup.sh # 安装
│ ├── mount.sh # 挂载
│ ├── check.sh # 检查
│ ├── deploy.sh # 部署
│ ├── backup.sh # 备份
│ ├── restore.sh # 恢复
│ ├── validate_yaml.sh # 验证YAML
│ ├── validate_docs.py # 验证文档
│ └── analyzers/ # 📊 分析器
│ ├── dependency.py # 依赖图
│ ├── complexity.py # 复杂度分析
│ └── diff.py # 版本比较
├── config/ # HA配置
├── backups/ # 本地备份
└── .cursor/ # MCP
📖 文档
- docs/setup/SETUP.md - 完整的MCP、SSH和SAMBA配置指南
- docs/reference/COMMANDS.md - 命令参考手册
- docs/reference/WORKFLOW.md - 工作流程和最佳实践
- SECURITY.md - 🔒 安全性和发布
💻 主菜单
./ha
交互式菜单，包含所有功能：
- 配置模式（本地/全局/混合）
- 挂载配置
- 检查状态
- 回滚更改
- 创建备份
- 从备份恢复
- 查看日志
- 启动审计
- 检查YAML ← 配置验证
- 检查文档 ← Markdown质量
- 卸载
📊 配置分析：
- 🕸️ 依赖图 (12) - 查找孤立实体、循环、影响分析
- 📈 复杂度分析 (第13项) - 复杂度评分、重构建议
- 🔄 比较更改 (第14项) - 提交间更改的风险评估
工作时间：
- 🏠 本地 - 一切通过本地网络（快速，仅限家中）
- 🌍 全球 - 一切通过互联网（较慢，任何地方都可用）
- 🔀 混合 - 自动选择（本地/ZeroTier/全球）
- 在家 → 直接连接（快速）
- 不在家 + ZeroTier → 通过VPN（安全）
- 没有ZeroTier → 通过白名单IP（备用）
📚 文档
完整的文档在GitHub Pages上：https://gfermoto.github.io/HASSio_Cursor
主要部分
- 📖 完整的安装说明 - 步骤指南
- ⚡ 快速开始 - 五分钟启动
- 📋 检查表或待办事项 命令参考手册 - 所有命令和脚本
- 🔄 （这个符号本身通常用于表示循环或循环，但在英语中作为一个独立词没有直接翻译。可以在上下文中描述为“旋转循环”或“循环”。）工作过程 - 如何使用该项目
- 🔒 安全 - 防止数据泄露
- 🔍 首次审计 - 分析您的系统
- 📊 配置分析器 - 依赖图、复杂度、差异
扩展主题
- 🌐 MikroTik端口转发 - 用于白名单IP
- 🔐 ZeroTier VPN + 混合模式 - 混合网络
- 🔒 通过SSH隧道访问SAMBA - 通过互联网安全访问
- 🏠 供暖优化 - 节省30%
💻 主要用途
# 编辑
code config/configuration.yaml
# 部署（带检查和备份）
./scripts/deploy.sh
# 查看日志
./scripts/view_logs.sh
# 恢复（如果出现问题）
./scripts/restore.sh
🤖 MCP (Cursor中的AI)
初始设置
# 1. 从示例创建配置
cp .cursor/mcp.json.example .cursor/mcp.json
# 2. 获取Home Assistant令牌
# 打开：http://YOUR_HA_IP:8123/profile/security
# 创建Long-Lived Access Token
# 3. 编辑配置
nano .cursor/mcp.json
# 替换YOUR_HA_TOKEN和YOUR_HA_URL
使用方法
只需询问Cursor中的AI：
"家里的温度是多少？"
"打开厨房的灯"
"显示所有恒温器"
"创建一个晚上照明自动化"
MCP通过以下方式操作：
- 🌐 HTTP API - 直接到您的HA
- 🔒 安全 - 令牌仅本地
🛡️ 安全
所有敏感数据（config.yml，.cursor/mcp.json，.ssh/）通过.gitignore排除在Git之外。
发布前检查：./scripts/check_security.sh
🤝 项目贡献
我们很高兴收到任何帮助！参见。CONTRIBUTING.md
📄 许可
MIT许可 - 免费使用！
🔗 有用链接
🌟 项目支持
如果项目对您有用：
- ⭐ GitHub上点赞
- 📢 告诉您的朋友
- 🐛 报告错误
- 💡 提出改进意见
感谢您使用HASSio Cursor！ 🎉
📊 状态
- MCP: ✅ 工作正常
- SSH: 🔧 需要配置（参见docs/setup/SETUP.md）
- SAMBA: 🔧 需要配置（参见docs/setup/SETUP.md）
🔗 链接
配置后config.yml：
- Home Assistant：查看
config.yml - MCP服务器：查看
.cursor/mcp.json