Skip to content

Commit dd7b9a2

Browse files
authored
Update README.md
1 parent 30a198b commit dd7b9a2

1 file changed

Lines changed: 10 additions & 93 deletions

File tree

README.md

Lines changed: 10 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -185,16 +185,16 @@ If you find this project useful and want to support its development, **please co
185185

186186
---
187187

188-
## 🤖 Using with Cursor AI
188+
## 🤖 Using with AI IDE (Cursor, VS Code etc)
189189

190-
This add-on enables **Cursor AI to autonomously manage your Home Assistant** through natural language - no manual copy-pasting needed!
190+
This add-on enables **AI IDE to autonomously manage your Home Assistant** through natural language - no manual copy-pasting needed!
191191

192192
### ⚠️ Important Disclaimer
193193

194194
**This tool is designed for experienced Home Assistant users who understand what they're doing.**
195195

196196
-**Always review changes** before applying them to production systems
197-
- ⚠️ **Cursor AI can accidentally break your configuration** if given incorrect instructions or outdated information
197+
- ⚠️ **AI can accidentally break your configuration** if given incorrect instructions or outdated information
198198
- 💾 **Git versioning is enabled by default** - all changes are backed up and can be rolled back
199199
- 🔄 **Test in a safe environment first** if you're new to AI-driven automation
200200
- 📖 **Verify syntax and compatibility** with your Home Assistant version
@@ -217,9 +217,9 @@ Analyze my automations and suggest optimizations
217217
Create a smart lighting automation for movie mode
218218
```
219219

220-
Cursor AI will autonomously read your configuration, create components, and deploy everything automatically!
220+
AI will autonomously read your configuration, create components, and deploy everything automatically!
221221

222-
**That's it!** Cursor AI will use the MCP protocol to communicate with your Home Assistant.
222+
**That's it!** AI IDE will use the MCP protocol to communicate with your Home Assistant.
223223

224224
**Learn more:** [MCP Home Assistant on GitHub](https://github.com/Coolver/home-assistant-mcp) | [NPM Package](https://www.npmjs.com/package/@coolver/home-assistant-mcp)
225225

@@ -255,9 +255,9 @@ My bedroom lights automation isn't working. Check the logs,
255255
find the problem, and fix it.
256256
```
257257

258-
### What Cursor AI Can Do
258+
### What Vibecode Agent Can Do
259259

260-
With this add-on and [MCP integration](https://github.com/Coolver/home-assistant-mcp), Cursor AI can:
260+
With this add-on and [MCP integration](https://github.com/Coolver/home-assistant-mcp), AI IDE can:
261261

262262
**Analyze YOUR configuration** - detects your actual devices and entities
263263
**Create complex systems autonomously** - 10+ interconnected automations
@@ -273,55 +273,6 @@ With this add-on and [MCP integration](https://github.com/Coolver/home-assistant
273273

274274
---
275275

276-
## 🚀 Installation (Detailed)
277-
278-
### Option 1: Via GitHub Repository (Recommended)
279-
280-
1. Open **Settings****Add-ons****Add-on Store**
281-
2. Click **** (three-dot overflow menu in top right corner)
282-
3. Select **Repositories**
283-
4. Add repository URL: `https://github.com/Coolver/home-assistant-cursor-agent`
284-
5. Click **Add**
285-
6. Refresh the page - find **HA Vibecode Agent** in the list
286-
7. Click **INSTALL**
287-
8. Configure and start
288-
289-
### Option 2: Manual Installation (Alternative)
290-
291-
1. **Copy this folder** to `/addons/home-assistant-cursor-agent/` on your HA system via SSH/Samba/File Editor
292-
293-
2. **Reload Add-on repositories:**
294-
- Supervisor → Add-on Store → ⋮ → Check for updates
295-
296-
3. **Install the Add-on:**
297-
- Find "HA Vibecode Agent" in Local Add-ons
298-
- Click **INSTALL**
299-
300-
4. **Configure:**
301-
- Set port (default: 8099)
302-
- Enable Git versioning (recommended)
303-
- Set log level
304-
305-
5. **Start the Add-on**
306-
307-
6. **Get your API token:**
308-
- The add-on uses Home Assistant's Supervisor token
309-
- For external access, use your Long-Lived Access Token
310-
311-
---
312-
313-
## ⚙️ Configuration
314-
315-
```yaml
316-
port: 8099 # API port
317-
log_level: info # Logging: debug, info, warning, error
318-
enable_git_versioning: true # Enable automatic backups
319-
auto_backup: true # Auto-commit on changes
320-
max_backups: 30 # Maximum commits to keep (default: 30, cleanup keeps last 20)
321-
```
322-
323-
---
324-
325276
## 📚 API Documentation
326277

327278
### Interactive Documentation
@@ -496,12 +447,12 @@ DELETE /api/logs/clear
496447

497448
All API endpoints (except `/api/health`) require authentication.
498449

499-
### For MCP Clients (Cursor AI)
450+
### For MCP Clients (Cursor AI, VS Code etc)
500451

501452
The add-on uses **Agent Key** authentication:
502453

503454
1. Get your Agent Key from **Web UI** (Settings → Add-ons → HA Vibecode Agent → Open Web UI)
504-
2. Configure in Cursor MCP settings with `HA_AGENT_KEY`
455+
2. Configure in Cursor MCP / VS Code settings with `HA_AGENT_KEY`
505456
3. Agent Key is auto-generated on first start
506457

507458
### For Direct API Access
@@ -737,7 +688,7 @@ python -m uvicorn app.main:app --reload --port 8099
737688

738689
## 🎯 Use Cases
739690

740-
### For Cursor AI
691+
### For Cursor AI, VS Code + Co-Pilot etc
741692

742693
This add-on enables Cursor AI to:
743694

@@ -793,24 +744,6 @@ AI via Agent:
793744
3. Restarts HA
794745
4. Verifies restoration
795746
```
796-
797-
---
798-
799-
## 📊 API Overview
800-
801-
| Endpoint | Methods | Description |
802-
|----------|---------|-------------|
803-
| `/api/files` | GET, POST, DELETE | File operations |
804-
| `/api/entities` | GET | Entity states and services |
805-
| `/api/helpers` | POST, DELETE | Input helper management |
806-
| `/api/automations` | GET, POST, DELETE | Automation management |
807-
| `/api/scripts` | GET, POST, DELETE | Script management |
808-
| `/api/system` | POST, GET | System operations |
809-
| `/api/backup` | GET, POST | Git versioning |
810-
| `/api/logs` | GET, DELETE | Agent logs |
811-
| `/api/health` | GET | Health check (no auth) |
812-
| `/docs` | GET | Interactive API docs |
813-
814747
---
815748

816749
## ⚠️ Important Notes
@@ -873,27 +806,11 @@ Common issues:
873806

874807
---
875808

876-
## 📞 Support
877-
878-
- **Issues:** GitHub Issues
879-
- **Documentation:** `/docs` endpoint (Swagger UI)
880-
- **Logs:** `/api/logs/` endpoint
881-
882-
---
883-
884809
## 📜 License
885810

886811
MIT License - See LICENSE file
887812

888813
---
889814

890-
## 🙏 Credits
891-
892-
Created for seamless integration between **Cursor AI** and **Home Assistant**.
893-
894-
Enables AI to autonomously manage smart home configurations! 🏠🤖
895-
896-
---
897-
898815
**Ready to give your AI full control of Home Assistant? Install now!** 🚀
899816

0 commit comments

Comments
 (0)