コンテンツにスキップ

機能一覧とビジネスルール

Miseru が提供する機能と、その動作を規定するルールの一覧です。個々の値の根拠は制限とクォータ、仕組みの解説はアーキテクチャ概要を参照してください。

機能FreePro
AI エージェント撮影 → PR 表示(アップロード・配信)
推測不能 URL + HMAC 署名配信
1 PR = 1 コメントの自動集約(GitHub Action)
失効ポリシー: PR クローズで失効
失効ポリシー: N 日保持✅(短期)✅(カスタム)
失効ポリシー: 無期限
手動失効(ダッシュボード / CLI / API)
CLI / MCP / GitHub Action / Claude Code プラグイン
Kurabe(スクリーンショット差分検出)🚧 準備中
ベースライン管理・承認フロー🚧 準備中

Pro プランと Kurabe は準備中です。 現在は Free 相当の配信機能一式が提供されており、ダッシュボードの Kurabe 画面は UI プレビューです。

  • 認証: プロジェクト単位の Upload Token(msr_ + 64hex)。サーバーはハッシュのみ保存
  • 受け付ける画像: PNG / JPEG / WebP、5MB 未満
  • 必須メタデータ: 論理名(1〜200文字)・PR 番号・コミット SHA
  • レート制限: プロジェクトあたり 120回/分
  • 入口: CLI / MCP / GitHub Action / HTTP API
  • 署名付き URL(exp + HMAC、鍵バージョン付き)。URL を知らない第三者は到達不能
  • Cache-Control は保持期限から自動導出(失効予定が近いほど短くなる)
  • 失効後の新規アクセスは 404
  • コメントはサーバー側で PR 単位に再生成され、マーカー(<!-- miseru:pr-<n> -->)で常に1コメントに upsert
  • 形式: ### 📸 スクリーンショット(N枚) + 各画像(論理名・viewport・コミット SHA 7桁・画像)
  • 投稿者は github-actions[bot](あなたのリポジトリの Action 権限で投稿)
トリガー対象タイミング
PR クローズ(pr_close ポリシー)その PR の画像即時(Action 契機)
保持期限(retain_days ポリシー)期限を過ぎた画像毎時スイープ(最大1時間のずれ)
手動失効指定した1枚即時
トークン失効(revoke)※画像は消えないトークンが即時無効化
  • 失効順序は常に「オリジン削除 → 記録削除」。キャッシュ済みの配信は Cache-Control による自然失効(詳細: 配信とセキュリティの仕組み)
  • 失効処理の一時失敗は自動リトライされる(毎時スイープが完了させる)

アプリケーションの動作を規定するルールの網羅表です。

#ルール
1プロジェクトは GitHub リポジトリと 1:1。同一リポジトリの重複登録は不可
2プロジェクトはログインした GitHub アカウント配下のリポジトリ名(<アカウント>/<リポジトリ>)のみ登録できる
3失効ポリシーはプロジェクト単位。既定は pr_close
4ポリシー変更は新規アップロードから適用(既存画像の失効予定は不変)
5retain_days の失効時刻はアップロード時点で確定する(アップロード時刻 + N日)
6retain_days に設定できるのは 1〜365 日(ダッシュボード UI は 7 / 30 / 90 を提示)
7手動失効はポリシーに関係なく常に可能で、不可逆
8Upload Token の平文は発行時に一度だけ表示され、以後復元不能
9トークン失効は即時有効。失効済みトークンのリクエストはすべて 401
101つのトークンでアップロード・失効・コメント取得のすべてが可能(スコープ分割なし)
11トークンは自プロジェクトの画像しか操作できない(他プロジェクトの画像 ID は存在有無を隠して 404)
12配信 URL の署名有効期限は365日。ただし失効ポリシーによる削除が常に優先
13配信に閲覧時の認可はない(URL を知る者は閲覧可能)
14fork からの PR では Action はコメント投稿をスキップする(権限昇格をしない)
15レート制限の基盤障害時はアップロードを止めない(fail-open)
  • Kurabe(差分検出) — ベースラインとの画像差分・変化サマリ・承認フロー。ダッシュボードに UI プレビューあり
  • LLM による差分説明 — 変化内容の自然言語サマリ

提供時期は未定です。本ドキュメントは提供開始時に更新されます。