Gurubase

What is Gurubase
How to Create a Guru
How to Claim a Guru
Showcase Your Guru
How to Update Datasources
License
Help
Used By

What is Gurubase

Gurubase is a centralized RAG-based learning and troubleshooting assistant platform. Each "Guru" has its own custom knowledge base (such as the latest documentation, PDFs, YouTube videos, etc.) to generate answers for user queries. It is not a coding assistant like GitHub Copilot or similar tools.

How to Create a Guru

Currently, only the Gurubase team can create a Guru. Please open an issue on this repository with the title "Guru Creation Request" and include the GitHub repository link in the issue content. We prioritize Guru creation requests from the maintainers of the tools. Please mention whether you are the maintainer of the tool. If you are not the maintainer, it would be helpful to obtain the maintainer's permission before opening a creation request for the tool.

How to Claim a Guru

Although you can't create a Guru, you can manage it on Gurubase. For example, you can add, remove, or reindex the datasources. To claim a Guru, you must have a Gurubase account and be one of the tool's maintainers. Please open an issue with the title "Guru Claim Request". Include the link to the Guru (e.g., https://gurubase.io/g/anteon), your Gurubase username, and a link proving you are one of the maintainers of the tool, such as a PR merged by you.

Showcase Your Guru

Badge

Like hundreds of GitHub repositories, you can add a badge to your README to guide your users to learn about your tool on Gurubase.

Example Badge:

[![Gurubase](https://img.shields.io/badge/Gurubase-Ask%20OpenCost%20Guru-006BFF)](https://gurubase.io/g/opencost)

Widget

You can also add an "Ask AI" widget to your documentation by importing a small JS script. For an example, check the Connexion docs.

How to Update Datasources

Datasources can include your tool's documentation webpages, YouTube videos, or PDF files. You can add new ones, remove existing ones, or reindex them. Reindexing ensures your Guru is updated based on changes to the indexed datasources. For example, if you update your tool's documentation, you can reindex those pages so your Guru generates answers based on the latest data.

Once you claim your Guru, you will see your Gurus in the "My Gurus" section.

Click the Guru you want to update. On the edit page, click "Reindex" for the datasource you want to reindex.

You can also see the "Last Index Date" on the URL pages.

License

All the content generated by Gurubase aligns with the license of the datasources used to generate answers. More details can be found on the Terms of Usage page, Section 2.

Help

We prefer Discord for written communication. Join our channel! To stay updated on new features, you can follow us on X, Mastodon, and Bluesky.

Used By

Gurubase currently hosts hundreds of Gurus, and it grows every day. Here are some repositories that showcase their Gurus in their READMEs or documentation.