docs: update credential setup docs to reflect elicitation flow

This commit is contained in:
Jacob Magar
2026-03-14 04:29:35 -04:00
parent 85cd173449
commit f0a97edbf7
2 changed files with 29 additions and 0 deletions

View File

@@ -54,6 +54,23 @@ This provides instant access to Unraid monitoring and management through Claude
**See [.claude-plugin/README.md](.claude-plugin/README.md) for detailed plugin documentation.**
### ⚙️ Credential Setup (Automatic)
On first use, the plugin will **automatically prompt you for credentials** via an
interactive elicitation dialog in Claude Code. Simply call any Unraid tool and
follow the prompts — no manual `.env` configuration needed.
Alternatively, trigger setup explicitly:
```
unraid_health action=setup
```
Credentials are saved to `.env` in the plugin cache directory and persisted
across restarts.
> **Manual fallback:** If elicitation is not supported by your client, create
> `.env` in the plugin cache directory manually (see `.env.example` for the format).
---
## 🚀 Quick Start