Cool, but what does it do?¶
So, there are a lot of things/features that will never end up in Home Assistant itself.
This can have various reasons. For example, it is just too random, out of scope, not matching the Home Assistant philosophy, violates architectural design, is still in early development, experimental, explorative, or just freaking useless.
Spook doesn’t care. He is nobodies homie.
So, maybe, that one feature you wanted Home Assistant to have, is in the toolbox provided by Spook. All stuff in here, is not part of Home Assistant (or at least not yet) for a reason. So, don’t expect it to work, or to be supported, or, well, for starters, to be a good idea.
All that said, Spook is a scary powerful toolbox for Home Assistant, but be aware, Spook is not your homie!
What do I get from Spook?¶
Spook will add new features to Home Assistant and extend existing ones.
Spook will also add new entities to existing integration you use in your Home Assistant instance to provide more data points to monitor and control. For example, it will add entities to control and monitor your Home Assistant Cloud connection.
For our most advanced users, Spook adds new template functions to the template engine of Home Assistant. Making some of the most advanced templating possible, but also has functions that just make your life easier.
Finally, Spook will constantly float around in your Home Assistant, and if it finds potential issues along the way, it will report them to you. For example, if you are using a non-existing entity in your automations, Spook will let you know by raising an issue on your repairs dashboard.
Spook 👻 will extend your Home Assistant instance with a huge set of scary powerful tools. 🛠️
Sounds scary. I’m out!¶
Understood. Using the least amount of custom integrations is always the best way to go. So, if you are uncomfortable with this, don’t use Spook.
Don’t worry, it won’t bite, and it will not deliberately break your Home Assistant system. It is just not supported, and it is not part of Home Assistant. So, if you want to use it, you are on your own.
I like to learn more first¶
Even better, maybe check out the Background and the history of Spook 👻 page to learn more about the background and history of Spook. The Frequently asked questions (FAQ) page might also be a good place to start.
I’m in! How do I install it?¶
Follow the instructions on the dedicated page for that: Installing Spook in Home Assistant.