Skip to content

README_ja.md

Latest commit

 

History

History
71 lines (51 loc) · 2.68 KB

README_ja.md

File metadata and controls

71 lines (51 loc) · 2.68 KB
Raw

Prompt-Recon ロゴ

Prompt-Recon

個人リポジトリと小規模チーム向けのオフライン secrets スキャナー
ワークツリー、staged blob、到達可能な Git 履歴を検査し、候補値を外部へ送信しません。

English · 简体中文 · 繁體中文 · 한국어 · Español · Português · Русский · Français · Deutsch

機能

  • 古いリビジョンを checkout せずにファイル、staged blob、Git 履歴を検査。
  • AWS、GitHub、GitLab、OpenAI、Anthropic、Hugging Face、Slack、Stripe、npm、PyPI、Google API、秘密鍵、JWT、データベース URL、一般的な認証情報代入に対応。
  • 出力は常にマスキングされ、baseline には指紋だけを保存。
  • .gitignore、.promptignore、TOML 設定、allow マーカー、SARIF/JSONL/CSV/Markdown をサポート。

必要条件

  • Python 3.10–3.13
  • staged/履歴スキャンには Git

インストールと使用

python -m pip install promptrecon
promptrecon scan .
promptrecon scan --staged
promptrecon scan --history
promptrecon scan . --format sarif --output results.sarif

終了コードは 0（新しい未承認検出なし）、1（検出あり）、2（設定・Git・実行エラー）です。

Baseline と設定

promptrecon baseline create .
promptrecon baseline audit
promptrecon baseline update .

baseline は秘密本文を保存しません。.promptrecon.toml.example を .promptrecon.toml にコピーして除外とデータ形式のルールを設定できます。意図的な例外には # promptrecon: allow または # promptrecon: allow-next-line を使用します。

Git hook と安全な修復

promptrecon hook install
promptrecon patch settings.py --line 12 --env-var SERVICE_TOKEN
promptrecon patch settings.py --line 12 --env-var SERVICE_TOKEN --apply

既存 hook を黙って上書きせず、修復は --apply を明示した場合だけ原子的に書き込みます。実際の秘密を含む修復ファイルは作成しません。

開発とライセンス

python -m pytest
ruff check .
python -m mypy promptrecon
python -m build

MIT。LICENSE と CHANGELOG を参照してください。