CLI tool for querying DeepWiki documentation
Project description
DeepWiki CLI
A command-line tool for querying DeepWiki documentation for any GitHub repository.
DeepWiki provides AI-generated documentation for open source repositories. This CLI lets you explore documentation structure, read contents, or ask questions about any repository directly from your terminal.
Installation
Using uvx (recommended)
uvx ask-deepwiki --help
Using pip
pip install ask-deepwiki
From source
git clone https://github.com/4rays/ask-deepwiki
cd ask-deepwiki
uv sync
uv run ask-deepwiki --help
Usage
Get Documentation Structure
View the table of contents for a repository's documentation:
ask-deepwiki structure facebook/react
Output:
1. Overview
1.1 Repository Purpose
1.2 Key Technologies
2. Architecture
2.1 Fiber Reconciler
2.2 Scheduler
...
Get Full Documentation
Retrieve the complete documentation contents:
ask-deepwiki contents vercel/next.js
Note: This may return a large amount of text for repositories with extensive documentation.
Ask Questions
Ask natural language questions about a repository:
ask-deepwiki ask facebook/react "What is Fiber?"
Output:
Fiber is React's reconciliation algorithm introduced in React 16...
More examples:
ask-deepwiki ask langchain-ai/langchain "How do I create a chain?"
ask-deepwiki ask pytorch/pytorch "What optimizers are available?"
ask-deepwiki ask microsoft/vscode "How does the extension API work?"
Commands
| Command | Description |
|---|---|
ask-deepwiki structure <repo> |
Get documentation structure (table of contents) |
ask-deepwiki contents <repo> |
Get full documentation contents |
ask-deepwiki ask <repo> "<question>" |
Ask a question about the repository |
ask-deepwiki --version |
Show version |
ask-deepwiki --help |
Show help |
Repository Format
All commands expect the repository in owner/repo format:
facebook/reactvercel/next.jslangchain-ai/langchainmicrosoft/typescript
Requirements
- Python 3.10+
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ask_deepwiki-0.1.0.tar.gz.
File metadata
- Download URL: ask_deepwiki-0.1.0.tar.gz
- Upload date:
- Size: 4.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
174896de90d089e8009432de9455e9df2cc0f2875e15aff28df094abee5fe91b
|
|
| MD5 |
eb9b596f276c845a831c682489dd8012
|
|
| BLAKE2b-256 |
cce6bfad173b9ee226c440a787cdc7b4fd3c3d6bd82ab09d759125412a468501
|
Provenance
The following attestation bundles were made for ask_deepwiki-0.1.0.tar.gz:
Publisher:
publish.yml on 4rays/deepwiki-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ask_deepwiki-0.1.0.tar.gz -
Subject digest:
174896de90d089e8009432de9455e9df2cc0f2875e15aff28df094abee5fe91b - Sigstore transparency entry: 831811856
- Sigstore integration time:
-
Permalink:
4rays/deepwiki-cli@c9f96616d955231b66da4bedad132c1d5b37c2ce -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/4rays
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c9f96616d955231b66da4bedad132c1d5b37c2ce -
Trigger Event:
release
-
Statement type:
File details
Details for the file ask_deepwiki-0.1.0-py3-none-any.whl.
File metadata
- Download URL: ask_deepwiki-0.1.0-py3-none-any.whl
- Upload date:
- Size: 5.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
04f384b53aeae5795a960c4f4559edd9b99c3c80a0981e909055314befba50dc
|
|
| MD5 |
f99ecb3b73a7790d650052f0ab58a34f
|
|
| BLAKE2b-256 |
3c05cec46721c3d600c1a7adcd8941f7ab2bf99c0d1df91e3444e65c0a09f3d0
|
Provenance
The following attestation bundles were made for ask_deepwiki-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on 4rays/deepwiki-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ask_deepwiki-0.1.0-py3-none-any.whl -
Subject digest:
04f384b53aeae5795a960c4f4559edd9b99c3c80a0981e909055314befba50dc - Sigstore transparency entry: 831811860
- Sigstore integration time:
-
Permalink:
4rays/deepwiki-cli@c9f96616d955231b66da4bedad132c1d5b37c2ce -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/4rays
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c9f96616d955231b66da4bedad132c1d5b37c2ce -
Trigger Event:
release
-
Statement type: