deepwiki-open README

The project's README from github.com/AsyncFuncAI/deepwiki-open. As one markdown file: README.md.

DeepWiki-Open (Grok-Wiki)

grok-wiki

DeepWiki is my own implementation attempt of DeepWiki, automatically creates beautiful, interactive wikis for any GitHub, GitLab, or BitBucket repository! Just enter a repo name, and DeepWiki will:

  1. Analyze the code structure
  2. Generate comprehensive documentation
  3. Create visual diagrams to explain how everything works
  4. Organize it all into an easy-to-navigate wiki
  5. Generate codemap for code-centric guided tours

Tip in Crypto Twitter/X Discord

English | 简体中文 | 繁體中文 | 日本語 | Español | 한국어 | Tiếng Việt | Português Brasileiro | Français | Русский

Deepwiki-Open 2.0 (Grok Wiki is now live)

https://github.com/user-attachments/assets/48d1e60a-eb91-4c05-a5a8-3624ffb79fb1

🤝 Contributing

Contributions are welcome! Feel free to:

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

⭐ Star History

Star History Chart

deepwiki-open (AsyncFuncAI/deepwiki-open)

Searching Database…

Что это такое?DeepWiki-Open — это генератор вики с открытым исходным кодом на базе ИИ: вы даёте ему репозиторий на GitHub, GitLab или Bitbucket, и он автоматически создаёт красивую интерактивную вики с объяснением, как устроен код.
Так это готовый сайт в интернете или что-то, что я запускаю сам?Вы запускаете его сами как веб-приложение на своём сервере (self-hosted): интерфейс на Next.js открывается в браузере на порту 3000, есть поддержка Docker и Docker Compose для развёртывания на серверах. В README также анонсирована DeepWiki-Open 2.0 (Grok Wiki) — её можно скачать прямо сейчас.
Как его запустить?Склонируйте репозиторий и запустите через Docker Compose (сборка Docker-образа настроена в CI репозитория), либо выполните npm run dev — поднимется дев-сервер Next.js с Turbopack, и приложение откроется на localhost:3000.
Нужен ли платный AI-сервис, или можно работать на локальной модели?Согласно темам репозитория, поддерживается несколько AI-бэкендов — OpenAI, Google Gemini, OpenRouter и Ollama. То есть можно подключить ключ облачного API или указать локальную модель Ollama; главное — настроить хотя бы один провайдер.
Мне в наследство достался большой код — поможет ли мне это во всём разобраться?Это как раз основной сценарий: DeepWiki анализирует структуру кода, генерирует подробную документацию, рисует наглядные диаграммы того, как всё устроено, и добавляет codemap с экскурсиями по коду — и всё это собрано в удобную вики с навигацией.
Это бесплатно?Да — лицензия MIT, поэтому пользоваться, изменять и размещать на своём сервере можно свободно, в том числе в коммерческих целях.
Почему автор сделал это сам, а не воспользовался оригинальным DeepWiki?Это собственная open-source реализация идеи DeepWiki, сделанная автором: вариант с лицензией MIT, который можно развернуть у себя, чтобы каждый мог изучить код, запустить проект и развивать его, а не зависеть от облачного сервиса. С тех пор проект набрал более 18 тысяч звёзд на GitHub.
Что рисует диаграммы в сгенерированной вики?Mermaid — во фронтенде поверх интерфейса на Next.js/React используется библиотека mermaid, поэтому визуальные пояснения получаются в виде интерактивных диаграмм Mermaid.
А можно пользоваться на своём языке?Скорее всего да — README переведён на десять языков (английский, китайский в упрощённом и традиционном написании, японский, испанский, корейский, вьетнамский, португальский, французский, русский), а в приложении используется next-intl, так что сам интерфейс переведён.
What are similar projects?oxynote, gitdiagram, sim, Skill_Seekers, job-ops, opencodex, mike, WeKnora
Size
4.4 MB
Stars
18.2K
Updated
CommitSep 03
Age
1y
Commits · 90 Days