GitHubなどに置かれたプログラムの名前を入れるだけで、AIが中身を読んで解説サイトを作ってくれる仕組みです。構成の説明、仕組みを表した図、案内つきの読み進め方までまとめてくれます。他人が作ったプログラムを引き継いだ時や、大きなものの全体像をつかみたい時に使えます。日本語の説明も用意されています。
#ドキュメント#GitHub
これは何?黒い画面(ターミナル)で動かすツール
できること
GitHub・GitLab・BitBucketのプログラムの解析/解説サイトの自動生成/仕組みを表す図の作成/読み進める順序の案内/複数言語の説明
誰に効く?
引き継いだプログラムの中身を早く把握したい人。中身の説明書が無いものを扱う人
用意するもの
コマンド入力が必要です。使うAIの鍵が要ります。解析するプログラムの量に応じて利用料がかかります。
時間のめやす
15〜30分(AIに聞きながらコピペ)
使うとこうなる
- 1リポジトリ名を入れると→コード構造を解析する
- 2解析が進むと→説明文と図が生成される
- 3Wikiを見ると→全体像をページでたどれる
作れるもの・できることの例
リポジトリWiki、構成説明、コード理解用の図解
使えるようになるまでの手順をひらく
- 「」という文字だけの画面を使います(Windowsなら PowerShell)
- GitHubページの「Installation」に書かれたコマンドを順番に実行
- つまずいたら、いつも使っているAIチャットに「(ツール名)のインストールを手伝って」と聞くのがおすすめ
こんな人には向かないかも
- 黒い画面(ターミナル)にまだ抵抗がある人
- 登録やAPIキーの設定を一切やりたくない人
🔑 必要な鍵(APIキー)— 下のどれか1社でOK
すでにどこかの鍵を持っていればそれが使えます。まだ無いなら Google(Gemini)が一番かんたんです。
Google(Gemini) の発行ページ↗Googleアカウントがあれば無料で即発行。無料枠も大きく、一番かんたん
OpenAI(ChatGPT) の発行ページ↗発行は無料。APIはChatGPT Plus(月額)とは別勘定で、使った分だけの課金。※Codex等の一部公式ツールは、キーの代わりにChatGPTの月額プランでログインして使える
Anthropic(Claude) の発行ページ↗発行は無料。APIは月額プランとは別勘定で、使った分だけの課金。※Claude Codeは月額プラン(Pro等)のログインでも使える
鍵は「合鍵」の文字列。発行→コピー→ツールの設定に貼り付け、の3手です。迷ったらAIチャットに「画面つきで教えて」と。
迷ったらこれ:いつも使っているAIチャット(ChatGPT・Claude・Geminiなど)にこのツールのGitHubリンクを貼って 「これを使いたい。私のPCでの始め方を一歩ずつ教えて」と頼むのが一番の近道です。
むずかしそう? 同じジャンルで、もっと始めやすいのはこちら
注意点
AIが読んで書いた解説なので、実際の動きと食い違うことがあります。特に「なぜそうしているか」の説明は推測が混ざるため、鵜呑みにせず元のプログラムを確認してください。非公開のプログラムを解析させる場合、その中身は使っているAIサービスに送られます。社外に出せないものを扱う前に、送信範囲を確認してください。はMITです。
ひとことメモ
として公開されています。内容は公式ページでもご確認ください。
deepwiki-openについてよくある質問
- deepwiki-openは無料で使えますか?
- deepwiki-open自体は無料で使えますが、動かすのに外部AIのAPIキーが必要です。そのAI側の利用料は別にかかります(無料枠があるものもあります)。
- deepwiki-openを使うのに、インストールや専門知識は必要ですか?
- コマンド入力(黒い画面)での操作が必要です。手順どおりに文字を打ち込む作業に慣れていないと、導入でつまずきやすいツールです。
- deepwiki-openはスマホでも使えますか?
- スマホには対応していません。パソコンが必要です。
- deepwiki-openは仕事(商用)で使えますか?
- ライセンスは MIT で、商用利用も認められています。ただし著作権表示を残すなどの条件が付くので、配布物に含める場合はライセンス本文を確認してください。
文章・メモのほかのツール
deepwiki-openが合わなかったときの、同じ用途の候補です。
SillyTavern
上級者向けAIチャット画面
準備がいる・ターミナル操作あり
novel
Notion風の書き味にAI補完を足した編集画面の部品
上級者向け・ターミナル操作あり
avoid-ai-writing
AIっぽい文を修正
準備がいる・ターミナル操作あり
llm-wiki-compiler
素材からAI wiki生成
準備がいる・ターミナル操作あり
atomic
つながる個人知識ベース
準備がいる・ターミナル操作あり
humanize-text
AIが書いた文章を、人が書いたように書き直す道具
準備がいる・ターミナル操作あり