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 Homebrew (macOS)

brew install 4rays/tap/ask-deepwiki

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/react
• vercel/next.js
• langchain-ai/langchain
• microsoft/typescript

Requirements

• Python 3.10+

License

MIT