AlmanacCode/codealmanac

What it solves

CodeAlmanacは、コードだけではアーキテクチャの決定、過去の失敗、システムの不変条件、または複雑なサービス間ワークフローの背後にある理由を説明できないという、ソフトウェア開発における「コンテキストのギャップ」に対処します。コミットメッセージに埋もれたり、ドキュメントが散在したりして失われがちな、この高レベルなコンテキストをキャプチャする「リビング・ウィキ」を維持する方法を提供します。

How it works

このツールは、リポジトリ内の almanac/ ディレクトリの下に直接保存されるプレーンなMarkdownファイルで構成されるウィキを作成します。AIコーディングエージェント（Codex または Claude Code を介して）を使用して、主に以下の3つのプロセスを通じてこのウィキを自動的に維持します：

• Ingestion: AIエージェントがファイル、Git diffs、PRs、issues、およびエージェントのトランスクリプトをスキャンして、新しい知識をウィキに集約します。
• Gardening: 定期的なAI駆動のレビューにより、古いページを整理し、リンク切れを修正し、重複した情報を削除します。
• Syncing: 最近のAIエージェントとの会話をスキャンして、ウィキに役立つ知識を抽出してキューに追加するバックグラウンドプロセスです。

ユーザーは、CLIを使用してページを検索・表示したり、ローカルのウェブビューアを使用したりして、ウィキと対話できます。

Who it’s for

AIエージェントによって自動的に更新され、標準的なGitワークフローを通じてレビューされる、最新のプロジェクトドキュメントを維持したい開発者やチーム。

Highlights

• Git-native: ウィキはリポジトリ内のMarkdownとして保存されるため、変更はプルリクエストを通じてレビューされます。
• Automated Maintenance: macOS上のバックグラウンド launchd ジョブを使用して、手動の労力なしにウィキを同期し「ガーデニング」を行います。
• Agent-Integrated: Codex および Claude Code と直接統合し、会話のトランスクリプトを、永続的なドキュメントへと変換します。
• Local-first: すべてのウィキ作業とインデックス作成は、ユーザーのローカルマシン上で行われます。
• Web Viewer: ウィキのグラフを閲覧するための、読み取り専用のローカルウェブインターフェースが含まれています。