ターミナルが必要調べる

読む8分3ステップ公式資料をもとに整理

プロジェクト全体が、
「つながりの地図」になる。

できあがるもの

graphify-out フォルダに3ファイル:全体図(graph.html)、要点(GRAPH_REPORT.md)、問い合わせ用の地図(graph.json)。

コード・ドキュメント・PDFや画像のフォルダに graphify を使うと、全体図の graph.html、要点の GRAPH_REPORT.md、問い合わせ用の地図の graph.json の3つのファイルができる、という流れの概念図。
概念図(図の中の「概念図」の表示と同じ)

コードやドキュメントなどのフォルダ全体を、あとから問い合わせられる「つながりの地図」にする道具です。この記事では、入れ方と使い方を、公式READMEの記載にそって3ステップにまとめます。

まず貼るプロンプト7つの枠・タップで開く

そのままAIチャットに貼れます(タップで全選択 → コピー)

役割

ソフトウェアの導入を手伝うアシスタント。

状況

AIアシスタントの中で、公式READMEにそって graphify を入れたい。Python 3.10以上と、uv(または pipx)が使える環境。導入のあと、調べたいフォルダを「つながりの地図」にする。

入力ここだけ書き換える

調べたいフォルダ:〔ここに入れる。例:このプロジェクトのフォルダ〕

作業

次の順に進める。①Python が3.10以上か確認する。②uv tool install graphifyy を実行する。③graphify install を一度だけ実行する。④終わったら、「次に /graphify . と入力してください」と案内して止まる。

制約

パッケージ名は graphifyy(yが2つ)。公式READMEにない操作はしない。管理者権限が要る操作や、全体の設定を変える操作の前に、かならず確認する。既存のファイルを上書きしない。

出力

実行したコマンドと、その結果を、順番に短く一覧で報告する。

検証

④で止まる前に、graphify install が終わったことと、エラーが出ていないことを確認して報告する。確認できなければ、成功と言い切らず、足りないものを報告する。

最短ルート

まず、次の3つだけを済ませます。

  1. 下の公式資料3件で、入れ方と使い方を確認する。
  2. 「まず貼るプロンプト」を、AIアシスタントに貼って、導入までを進めてもらう。
  3. 導入が終わったら、調べたいフォルダで /graphify . と入力する。

準備するのは、Python 3.10以上と、uv(または pipx)です。

公式READMEでは、/graphify . を実行すると、graphify-out フォルダに graph.html・GRAPH_REPORT.md・graph.json の3つができるとされています。

graphify の流れを、自分と graphify の役割分担で並べた図。自分がコマンドを2つ入力し、graphify がAIアシスタントに登録し、自分が /graphify . と入力し、graphify が3ファイルを作る。
概念図自分と graphify の役割分担。公式READMEの記載にもとづく概念図です。
流れを12秒で。音なし・くり返し再生です。自作の動く図で、実際の画面ではありません。

前提

一言で
コードやドキュメントなどのフォルダを、あとから問い合わせられる「つながりの地図」(ナレッジグラフ)にする、AIアシスタント用の道具。
人気・作った人
GitHub ★133,926(10/24時点)。作成は Graphify-Labs(GitHubの組織)。
ライセンス
Apache-2.0(PyPIの表記)。READMEにはMITも併記されています。
必要な環境
Python 3.10以上と、uv(または pipx)。使うAIアシスタントは、Claude Code・Cursor・Codex・Gemini CLI・GitHub Copilot など。
費用
公式は、常時動かす有料のクラウド版(Graphify Cloud)も案内しています。この記事の手順は、CLIだけです。
  • graphify

    コード

    プロジェクト全体を「つながりの地図」にする。

    GitHub

Apache-2.0・累計★133,926(10/24時点)

手順

STEP 1 / 3

入れる

このステップでは、graphify の本体を入れて、使っているAIアシスタントに登録します。ここまでが、1回きりの準備です。

用語メモ:「CLI」は、文字で操作するコマンドの道具のことです。「uv」は、Pythonで作られた道具を入れるための道具です。

コマンド(タップで全選択 → コピー)

uv tool install graphifyy
graphify install

公式READMEでは、パッケージ名は graphifyy(yが2つ)で、graphify などの別名のパッケージは無関係だと説明されています。1つ目のあとに graphify install を一度実行すると、使っているAIアシスタントを見つけて、スキルを登録するとされています。

uvのドキュメントでは、uv tool install で入れた道具の実行ファイルは、PATH の通った場所に置かれると説明されています。PATH にない場合は警告が出て、uv tool update-shell が案内されています。

pipx を使う場合は、pipx install graphifyy です(READMEの記載)。すでに入れてある場合は、このステップは飛ばせます。

STEP 2 / 3

AIアシスタントで一言

このステップでは、AIアシスタントを開いて、調べたいフォルダで /graphify . と入力します。

AIアシスタントに入力(タップで全選択 → コピー)

/graphify .

公式READMEでは、/graphify . で、いまのフォルダが「地図」になるとされています。Codex では、/graphify ではなく $graphify を使うと書かれています。ほかに、/graphify query・path・explain といったコマンドもあります。

AIアシスタント画面の構造を、抽象的な図形で示したイメージ図。やりとりの表示エリアの下に入力欄があり、その入力欄に①「/graphify .」と入力する。実際の画面ではありません。
①の入力欄に打ちます。画面の構造を図形で示したイメージ図です。

コードの解析は手元で行われ、LLMは使われず、コードは外に出ないと、公式は説明しています。ドキュメント・PDF・画像・動画の読み取りは、使っているAIのモデル(または設定したAPIキー)が行います。

コマンド「/graphify .」を入力すると、graph.html・GRAPH_REPORT.md・graph.json の3つのファイルが graphify-out フォルダにできる、という流れの図。
概念図入力と、できるもの。公式READMEの記載にもとづく概念図です。

うまく入力できないときは、前のステップの graphify install を、もう一度確認します。

STEP 3 / 3

出力を開く

このステップでは、graphify-out フォルダにできたファイルを開きます。

ファイル中身
graph.html全体図。ブラウザで開いて、ノードをクリック・絞り込み・検索できます。
GRAPH_REPORT.md要点。重要な概念、意外なつながり、聞いてみる質問の候補。
graph.json問い合わせ用の地図。ファイルを読み直さなくても、あとから問い合わせられます。

地図のつながりには、ソースに書かれていたもの(EXTRACTED)と、推定したもの(INFERRED)の印が付くと、公式は説明しています。推定のつながりは、元のファイルで確かめてから使います。

graph.json は、今回は開かなくても大丈夫です。あとから問い合わせるときに使われる形です。

つまずいたとき

こんなとき試すこと公式資料の対応
graphify が見つからないuv tool install graphifyy のあと、PATH を確認する。uv が警告を出していれば、案内された uv tool update-shell を実行する。uv:Using tools
別のパッケージが入ってしまったパッケージ名が graphifyy(yが2つ)になっているか確認する。graphify などの別名は無関係とされている。README/PyPI
/graphify が使えないgraphify install を一度実行したか確認する。実行すると、使っているAIアシスタントを見つけて登録するとされている。README
Codex で /graphify が動かないCodex では、/graphify ではなく $graphify を使うと書かれている。README
Python が古いと言われるPython 3.10以上が必要とされている。README/PyPI
確認ポイントのチェックリスト。パッケージ名は graphifyy(yが2つ)、graphify install を1回実行した、Python 3.10以上がある、Codex では $graphify を使う。
確認ポイントの例です。

できないこと・確認できていないこと

  • この記事の手順は、実際に動かして確認したものではありません。公式README・PyPI・uvのドキュメントにもとづく整理です。
  • graph.html など、出力の見た目は確認していません。図の「イメージ図」は、実際の画面ではありません。
  • コマンド名や表示は、バージョンによって変わることがあります(PyPIでは、最新版が10/27公開の 0.9.97 と表示されていました)。
  • 日本語のフォルダ名・ファイルでの動作は、公式資料では確認できていません。
  • Graphify Cloud(有料のクラウド版)の料金と範囲、AIアシスタントごとの無料範囲・料金は、確認していません。

公式資料

あとで使う方は保存を。

次のガイド

一覧