Help & orientation
This page is a short overview. For full guides and reference, use the repository README until a docs URL is configured for this deployment.
Documentation
Full manuals are hosted separately. Set PUBLIC_DOCS_SITE_URL
for a direct link here, or use the repository README below.
If the docs site is down, use the GitHub README and issues .
Getting started
Pre-built installers are not published yet. Clone the repository , follow the Download page for a source build, then choose a vault folder on first launch—the same local-database model as the released app.
For build steps, first-run detail, and workflows, follow the README in the repository.
AI assistant
The default assistant path uses Ollama on your machine (typically localhost)—not a Grimoire-hosted model API. Whether the assistant uses your notes depends on in-app settings you control.
Model setup, retrieval options, and UI behavior are documented on the docs site.
Privacy & your data
There is no Grimoire cloud for your vault: you choose a folder, and notes plus local indexes stay on disk under your control. Optional features that touch the network (for example library or catalogue downloads) only run when you enable them.
For storage layout and optional features, see the app README on GitHub .
Bugs & feature ideas
Use the bug report page to pre-fill version and platform when reporting from the app, or open an issue on GitHub. Discussions and contributions are welcome on the repository.
Quick answers
Short summaries below; use the documentation for depth.
Is Grimoire really free?
Yes. Grimoire is open source under the GNU GPL v3 with no paywalled core features today. Licensing and optional future offerings are explained in the documentation and repository.
Where is my data stored?
In a vault folder you choose on your machine—local database and indexes on disk, not on Grimoire’s servers. Export to Markdown when you want portable files. See the documentation for storage layout and backup ideas.
How do I report a bug or request a feature?
Use the bug report page when coming from the app, or open an issue on GitHub. I welcome contributions and feedback.
Still have questions?
See the GitHub repository for the README, discussions, and issues.