Metadata-Version: 2.4
Name: ask-deepwiki
Version: 0.1.0
Summary: CLI tool for querying DeepWiki documentation
Project-URL: Homepage, https://github.com/4rays/deepwiki-cli
Project-URL: Repository, https://github.com/4rays/deepwiki-cli
Project-URL: Issues, https://github.com/4rays/deepwiki-cli/issues
Author: DeepWiki CLI
License: MIT
Keywords: cli,deepwiki,documentation,mcp
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.10
Requires-Dist: click>=8.0.0
Requires-Dist: httpx>=0.27.0
Requires-Dist: mcp>=1.0.0
Description-Content-Type: text/markdown

# DeepWiki CLI

A command-line tool for querying [DeepWiki](https://deepwiki.com) 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)

```bash
uvx ask-deepwiki --help
```

### Using pip

```bash
pip install ask-deepwiki
```

### From source

```bash
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:

```bash
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:

```bash
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:

```bash
ask-deepwiki ask facebook/react "What is Fiber?"
```

Output:
```
Fiber is React's reconciliation algorithm introduced in React 16...
```

More examples:

```bash
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
