Required API key
DeepWiki-Open requires two API keys to support its core functionality:
- Google Gemini API key: for document generation and streaming Q&A features, to be obtained from Google AI Studio
- OpenAI API Key: for code embedding analysis, available from the OpenAI Platform.
Important Notes
- API keys need to be valid and have sufficient quota, invalid keys will cause document generation to fail
- While DeepWiki-Open itself is free, API calls may incur third-party fees (depending on usage)
- Keys are stored in a local .env file to ensure their security
- When Docker is deployed, keys can be passed directly via environment variables without storing them in files
- For very large codebases, the number of API calls may be high and close monitoring of quotas is recommended
Notably, despite the use of third-party AI services, all code analysis and processing is done locally, ensuring the security and privacy of the code and data.
This answer comes from the articleDeepWiki-Open: Automatically Generating AI Documentation for GitHub, GitLab RepositoriesThe