Skip to article frontmatterSkip to article content
Getting started


Getting directions in this rollercoaster theme park. 🎒

Spook is provided as-is, without any warranty, and above all: Is absolutely unsupported by the Home Assistant project. However, if you run into issues, where should you go?

Hello IT, have you tried turning it off and on again? Meme from the IT Crowd.

Lucky for you, there are a few places where you can get help.

There are also some language-specific communities:

I’m sure I’ve found a bug!ΒΆ

Great! πŸŽ‰ Well, not really, but at least it means we can look into fixing it, so others won’t experience the same issue.

Please report the bug on the Spook issue tracker on GitHub.

If you are a developer, you can also submit a pull request with a fix. That would be even more awesome! 🀩

I have a feature request!ΒΆ

Yeah? Got something to make Spook even better? Awesome! 🀩

Please share your idea on the Spook discussion forum on GitHub.

I have so many more questions about Spook πŸ˜΅β€πŸ’«ΒΆ

Well, there is a lot more documentation on Spook to explore. You can find it all in the sidebar on the left.

If you like to learn more about Spook, the Background and the history of Spook πŸ‘» and the Frequently asked questions (FAQ) pages might be good starting points to find answers to your questions. Otherwise, the resources mentioned at the top of this page are good places to get your questions answered.

The documentation sucks! 😭¢

Documentation always does, but thanks for complimenting my hard work πŸ˜‚. It is a never-ending story. However, you can help! 🀩

Feel free to suggest an improvement on the Spook discussion forum on GitHub or, even better, open a pull request with your changes on our GitHub repository.

More information on helping out with the documentation can be found the development section of the documentation.