ESPHome Encyclopedia

v0.1.4

ESPHome configuration/component documentation-first workflow for ESPHome-specific questions, YAML/config authoring, config review, component selection, subst...

0· 115·0 current·0 all-time
MIT-0
Download zip
LicenseMIT-0 · Free to use, modify, and redistribute. No attribution required.
Security Scan
VirusTotalVirusTotal
Benign
View report →
OpenClawOpenClaw
Benign
high confidence
Purpose & Capability
Name/description match the actual behavior: the scripts and SKILL.md implement a docs-first workflow, local cache layout, and workspace initialization. The included scripts (cache_doc.py and init_workspace.py) are directly related to caching official ESPHome docs and creating the .ESPHome-Encyclopedia workspace.
Instruction Scope
SKILL.md instructs the agent to consult and cache official docs and to inspect/configure ESPHome YAML and dashboards. This is appropriate for an ESPHome config helper, but it implies the agent may read workspace files (the .ESPHome-Encyclopedia tree) and any user-provided configs; ensure the agent is only given files you want it to see and that secrets are not stored in the cache or notes.
Install Mechanism
No install spec; scripts are included in the bundle and nothing is downloaded or executed at install time. The cache script does perform network fetches at runtime but restricts requests to https://esphome.io (see ALLOWED_NETLOCS) rather than arbitrary URLs.
Credentials
The skill requests no environment variables, credentials, or config paths. The only filesystem footprint is the .ESPHome-Encyclopedia workspace the skill creates/uses; users should avoid storing secrets (passwords, API keys, tokens) in those workspace files.
Persistence & Privilege
always is false and the skill does not attempt to modify system-wide agent settings. The provided init script creates a self-contained workspace under the user's current directory; this is a limited, proportionate level of persistence.
Assessment
This skill appears to do exactly what it says: fetch and cache official ESPHome docs and help with ESPHome YAML/config work. It does not request credentials and only fetches from esphome.io. Before installing or running: (1) avoid putting credentials or sensitive tokens into the .ESPHome-Encyclopedia notes or inventory files (the skill encourages storing 'access' and 'dashboard' notes which could be sensitive), (2) only provide the agent with the specific device/config files needed for a task (don't let it read arbitrary system files), and (3) review any cached files you create to ensure they don't contain secrets. If you need higher assurance, inspect the two scripts (cache_doc.py and init_workspace.py) yourself — they are short, constrained, and only allow https://esphome.io requests by design.

Like a lobster shell, security has layers — review code before you run it.

latestvk97c4j7md4ea0n3t8hck6w15cx83pc2y

License

MIT-0
Free to use, modify, and redistribute. No attribution required.

Runtime requirements

🔌 Clawdis

Comments