kasu 0.0.3

KASU: Kind of ASsemble Utility for merging and sanitizing text files in a directory

KASU

AI駆動開発におけるコードベースの抽象化と管理の支援ツール

主な機能

• 複数ファイルの統合 - ディレクトリ内のテキストファイルを1ファイルに結合
• パス付きヘッダー - 各ファイルの内容をパス付きで区切り
• 出力形式 - プレーンテキストまたはMarkdown形式
• フィルタリング - Globパターン、除外パターン、.gitignore対応
• ディレクトリツリー表示 - プロジェクト構造の可視化
• ファイル一覧表示 - 対象ファイルのリストアップ
• 部分的な内容抽出 - 各ファイルの先頭/末尾N行のみ抽出
• 機密情報のサニタイズ - IPアドレス、メール、APIキーなどの自動置換
• 設定ファイル対応 - .config.yamlでデフォルト設定を管理

インストール

git clone [e-mail]:remokasu/kasu.git
cd kasu
pip install -e .

クイックスタート

ks -i [INPUT_DIR] -o [OUTPUT_FILE]

使い方

• 指定したディレクトリ以下のテキストファイルを結合して1ファイルに出力

  • プレーンテキストで出力

    ks -i [DIR] -o [FILE]
    

  • Markdown形式で出力

    ks -i [DIR] -o [FILE.md] --format md
    

    または

    ks -i [DIR] -o [FILE.md] -f md
    

  • 標準出力に出力

    ks -i [DIR] --stdout
    

• tree 情報を出力

  • 標準出力に出力

    ks -i [DIR] --tree
    

    または

    ks -i [DIR] -t
    

  • -o で指定したファイルの先頭に出力

    ks -i [DIR] -o [FILE] --tree
    

    または

    ks -i [DIR] -o [FILE] -t
    

    • i で指定したディレクトリ以下のファイル内容が続きます。

  • -o で指定したファイルにtree情報のみを出力

    ks -i [DIR] -o [FILE] --tree --no-merge
    

    --no-mergeを指定することで、-iで指定したディレクトリ以下のファイル内容は出力されません。

  • 出力例

    Auto-detected and using: ./.gitignore
    Scanning files...
    Found 5 files
    Ignored by patterns: 2 files/directories
    
    Directory tree:
    example-project/
    ├── docs/
    │   └── README.md
    ├── src/
    │   ├── config.json
    │   ├── main.py
    │   └── utils.py
    └── tests/
        └── test_main.py
    

• ファイル一覧を標準出力に出力

  • 標準出力に出力

    ks -i [DIR] --list
    

    または

    ks -i [DIR] -l
    

  • -oで指定したファイルの先頭に出力

    ks -i [DIR] -o [FILE] --list
    

    または

    ks -i [DIR] -o [FILE] -l
    

    -i で指定したディレクトリ以下のファイル内容が続きます。

  • -o で指定したファイルにファイル一覧のみを出力

    ks -i [DIR] -o [FILE] --list --no-merge
    

    --no-mergeを指定することで、-iで指定したディレクトリ以下のファイル内容は出力されません。

  • 出力例

    Auto-detected and using: ./.gitignore
    Scanning files...
    Found 5 files
    Ignored by patterns: 2 files/directories
    
    File list:
    tests/test_main.py
    src/utils.py
    src/config.json
    src/main.py
    docs/README.md
    

• 条件を指定して対象ファイルを絞り込み

  • -gで含めるファイルパターンを指定します。

    例: -g "*.py" で拡張子が.pyのファイルのみ対象にします。

    ks -i [DIR] -o [FILE] -g "*.py"
    

    複数指定

    ks -i [DIR] -o [FILE] -g "*.py" "*.md"
    

• 対象から特定のファイルを除外

  • -iで指定したディレクトリ以下に.gitignoreがあれば自動的に除外します。

  • --ignoreで、除去対象を記載したファイルを指定できます。

    このファイルは.gitignoreと同じ書き方ができます。

    --ignore を指定した時は.gitignore は無視されます。

  • --no-auto-ignoreで.gitignoreの自動検出を無効化できます。

  • -xで指定したパターンを除外します。

    もし対処に.gitignoreがあり、かつREADME.mdを除外したい場合、以下のようにします。

    ks -i [DIR] -o [FILE] -x "README.md"
    

• サニタイズ

  コンフィデンシャルな情報を自動的に検出して置換します。

  ただし、確実に検出できるわけではありません。

  1. APIキー: api_key=, apikey=, api-secret= などの後に続く20文字以上の英数字を検出

     置換形式: [REDACTED_API_KEY_1], [REDACTED_API_KEY_2], ...
     

  2. パスワード: password=, passwd=, pwd= などの後に続く6文字以上の値を検出

     置換形式: [REDACTED_PASSWORD_1], [REDACTED_PASSWORD_2], ...
     

  3. AWSキー - AKIA で始まる16文字の英数字を検出

     置換形式: [REDACTED_AWS_KEY_1], [REDACTED_AWS_KEY_2], ...
     

  4. メールアドレス - 標準的なメール形式を検出

     置換形式: [REDACTED_EMAIL_1], [REDACTED_EMAIL_2], ...
     

  5. IPアドレス - パブリックIPのみ検出（ローカルIP 127., 192.168., 10. は除外）

     置換形式: [REDACTED_IP_1], [REDACTED_IP_2], ...
     

  6. 秘密鍵 - PEM形式の秘密鍵全体を検出

     置換形式: [REDACTED_PRIVATE_KEY]
     

• 置換パターンを指定

  • フォーマット

    変換前 変換後
    

  • 例

    ks -i [DIR] -o [FILE] --replace [PATTERN_FILE]
    

    または

    ks -i [DIR] -o [FILE] -r [PATTERN_FILE]
    

• 各ファイルの先頭/末尾N行のみ出力

  • 先頭N行

    ks -i [DIR] -o [FILE] --head N
    

  • 末尾N行

    ks -i [DIR] -o [FILE] --tail N
    

• 設定ファイルを指定

  • --config [FILE], または -c [FILE]で設定ファイルを指定できます。

  • 設定ファイルの例

    input: .
    output: output.md
    format: md
    glob:
      - "*.py"
      - "*.md"
    exclude:
      - "tests/"
      - "docs/"
    head: 50
    sanitize: true
    

  • コマンドラインオプションで指定した値が優先されます。

  • 例

    ks --config config.yaml
    

    または

    ks -c config.yaml
    

コマンドラインオプション一覧

オプション	短縮形	説明
--input DIR	-i	入力ディレクトリ（デフォルト: .）
--output FILE	-o	出力ファイルパス
--stdout	-	標準出力に出力
--format FORMAT	-f	出力形式（text/markdown/md）
--glob PATTERN	-g	含めるファイルパターン
--exclude PATTERN	-x	除外パターン
--ignore FILE	-	ignoreファイルを指定
--no-auto-ignore	-	.gitignore自動検出を無効化
--head N	-	各ファイルの先頭N行のみ
--tail N	-	各ファイルの末尾N行のみ
--tree	-t	ディレクトリツリーを表示
--stats	-	統計情報を表示
--sanitize	-s	機密情報を自動サニタイズ
--replace FILE	-r	カスタム置換パターンファイル
--yes	-y	確認プロンプトをスキップ
--debug	-d	デバッグ情報を表示
--config FILE	-c	設定ファイルを指定