ai digest
1.0.0
コードベースを 1 つの Markdown ファイルに集約し、Claude プロジェクトまたはカスタム ChatGPT で使用するための CLI ツール。
指定されたディレクトリとサブディレクトリ内のすべてのファイルを集約します
一般的なビルドアーティファクトと構成ファイルを無視します
コードベース全体を含む単一の Markdown ファイルを出力します。
空白の削除とカスタム無視パターンのオプションを提供します
まず、プロジェクト ディレクトリで CLI ツールを実行します。
npx aiダイジェスト
これにより、コードベースを含むcodebase.mdファイルが生成されます。
コードベースを含む Markdown ファイルを生成したら、それを ChatGPT や Claude などの AI モデルで使用して、コードの分析と支援を行うことができます。
カスタム GPT を作成する
生成された Markdown ファイルを GPT のナレッジ ベースにアップロードします。
新しいプロジェクトを作成する
Markdown ファイルをプロジェクトのナレッジに追加します
最良の結果を得るには、新しいチャット セッションを開始する前に Markdown ファイルを再アップロードして、AI にコードベースの最新バージョンが確実に適用されるようにします。
-i, --input : 入力ディレクトリを指定します (デフォルト: 現在のディレクトリ)
-o, --output : 出力ファイルを指定します (デフォルト: codebase.md)
--no-default-ignores : デフォルトの無視パターンを無効にします
--whitespace-removal : 空白の削除を有効にする
--show-output-files : 出力に含まれるファイルのリストを表示します。
--ignore-file : カスタム無視ファイルを指定します (デフォルト: .aidigestignore)
--help : ヘルプを表示します
基本的な使い方:
npx aiダイジェスト
入力と出力を指定します。
npx ai-digest -i /path/to/your/project -o project_summary.md
空白の削除を有効にする:
npx ai-digest --whitespace-removal
含まれているファイルのリストを表示します。
npx ai-digest --show-output-files
複数のオプションを組み合わせます。
npx ai-digest -i /path/to/your/project -o project_summary.md --whitespace-removal --show-output-files
ai-digest は、プロジェクトのルート ディレクトリにある.aidigestignoreファイルを使用してカスタム無視パターンをサポートします。このファイルは.gitignoreと同様に機能し、集計から除外するファイルとディレクトリを指定できます。
--show-output-filesフラグを使用すると、どのファイルが含まれているかを確認できるため、除外候補を特定しやすくなります。
--whitespace-removalフラグを使用すると、ai-digest はファイルから余分な空白を削除し、AI モデルで使用するときにトークン数を削減します。この機能は、Python や YAML などの空白に依存する言語では無効になっています。
バイナリ ファイルと SVG は、ファイル タイプに関するメモとともに出力に含まれます。これにより、AI モデルは、完全なコンテンツを含めることなく、これらのファイルを認識できるようになります。
npm run start実行して、ローカル プロジェクトで CLI ツールを実行します。 （とてもメタ的！）
テストを実行するには、 npm test実行します。
CLI にフラグを渡すには、 npm run start -- --whitespace-removalのように--フラグを使用します。
npm publish
貢献は大歓迎です!お気軽にプルリクエストを送信してください。
このプロジェクトは MIT ライセンスに基づいてライセンスされています。
