plannotator/herdr-annotate
Annotate terminal text, review documents and agent replies in Herdr, and send the feedback straight back to the agent.
herdr‑annotate とは?
herdf‑annotate は、Herdr ターミナル/AIエージェント環境向けの Rustベースのプラグインです。これにより、以下のことが可能になります。
- 任意のターミナル出力を選択し、アクティブなLLMエージェントに送信できる番号付きMarkdownアノテーションに変換します。
- 関連プロジェクト plannotator‑tui を利用したTUIで、Markdownドキュメント全体やエージェントの以前の返信をレビューできます。
- これらのアノテーションを、Herdr内から直接、管理、コピー、アーカイブ、貼り付けをしてエージェントのプロンプトに送り込めます。
要するに、ターミナルで見る生のテキストと、LLM搭載アシスタントのフィードバックループの間のギャップを埋めます。
主な機能
| 機能 | 説明 |
|---|---|
| フル vs ライトインストール | フル はドキュメントレビューUIを追加します。ライト はターミナルテキストのアノテーションのみを提供します。 |
| キーボード操作のワークフロー | prefix+a (キャプチャ)、prefix+ctrl+s (送信&アーカイブ)、prefix+o (フォルダレビューを開く) などのキーバインドで、ターミナルから離れずに操作できます。 |
| Markdownフィードバック形式 | アノテーションは、ワークスペース/タブのメタデータと引用されたソーステキストを含む ## Annotation N ブロックとして出力され、LLMが消費する準備が整います。 |
| クリップボード対応 | macOS/Linuxではシステムクリップボード (wl‑clipboard、xclip、xsel)、WindowsではPowerShellを使用し、リモートセッション用にOSC 52も出力します。 |
| エージェント非依存 | Claude Code、Codex、pi、Copilot CLI、Droid、Hermes CLI、OpenCodeなどと連携します。 |
| リモートセッション対応 | SSHや herdr --remote 経由で、ローカルのキー押下を必要とせず、herdr plugin action invoke annotate.capture を呼び出して起動できます。 |
| リンクアドオン | file://*.md リンクを Ctrl‑click するとplannotator‑tuiレビューアで開くようにするオプションのアドオンです。 |
| クロスプラットフォーム | macOS、Linux、Windows (フルバリアントはプレビュー版)。 |
インストール
# フルインストール (デフォルト) – ドキュメントレビューUIを含む
herdr plugin install plannotator/herdr-annotate
# ライトインストール – ターミナルアノテーションのみ
herdr plugin install plannotator/herdr-annotate/lite
# Windowsフル (プレビュー) – Herdr ≥ 0.9.0 が必要
herdr plugin install plannotator/herdr-annotate/windows-full
このコマンドは、プリビルドの herdr-annotate バイナリをダウンロードし、SHA‑256チェックサムを検証して、Herdrプラグインとして登録します。追加のランタイムは不要です。
基本的な使い方 (フルインストール)
| キー | アクション |
|---|---|
prefix+a |
選択したターミナルテキストをアノテーションとしてキャプチャします。 |
prefix+shift+a |
すべてのアノテーション (Markdown) をクリップボードにコピーします。 |
prefix+ctrl+a |
すべてのアノテーションをコピーしてアーカイブします。 |
prefix+ctrl+v |
アノテーションをフォーカス中のエージェントのプロンプトに貼り付けます (送信はしません)。 |
prefix+ctrl+s |
アノテーションを次のエージェントメッセージとして送信してアーカイブします。 |
prefix+m |
アノテーションマネージャを開きます (一覧、コピー、アーカイブ、削除)。 |
prefix+o |
フォルダ全体のドキュメントレビューア (plannotator‑tui) を開きます。 |
prefix+shift+o |
エージェントの最新の返信をレビューします。 |
prefix+ctrl+o |
ピッカーなしで最新の返信をレビューします。 |
マネージャーペインは、アノテーションが作成された順序で表示するため、LLMはフィードバックを順番に受け取ります。
ドキュメントレビュー (フルインストール)
prefix+oを押して、現在のフォルダのファイルツリービューを起動します。prefix+shift+oまたはprefix+ctrl+oを使用して、最近のエージェント返信を参照します。- TUI内で編集、コメント、送信 ができ、レビューをエージェントに返せます (
Eで送信、qで終了)。 - オプションの Links アドオン をインストールして、
file://*.mdリンクをCtrl‑clickで直接レビューアで開くようにできます:herdr plugin install plannotator/herdr-annotate/links
リモート / SSH ワークフロー
- 選択を保持 するには、サーバーの
~/.config/herdr/config.tomlでcopy_on_select = falseを設定します。 - ローカルマシンから、キー押下なしでキャプチャアクションを呼び出します:
ssh host herdr plugin action invoke annotate.capture - プラグインはHerdrのAPIを介して選択を読み取り、ローカルクリップボードの必要性を回避します。
開発と拡張性
- プラグインは
rust/にあり、Cargoでビルドされます。 - 一般的な開発サイクル:
cargo test --manifest-path rust/Cargo.toml cargo clippy --manifest-path rust/Cargo.toml -- -D warnings bash scripts/stage-local.sh # バイナリをビルドしてステージング herdr plugin link $PWD # ローカルテスト用にリンク - それぞれのディレクトリをリンクすることで、Lite と Full バリアントを切り替えられます。
- Links アドオン はコンパイルされたコンポーネントを持たず、
file://クリックをFullバイナリに転送するプラグインを登録するだけです。
こんな方におすすめ
- LLMを活用した開発者 で、ターミナルで作業し、コード出力、エラーメッセージ、ログにすばやく注釈を付けてアシスタントにフィードバックしたい方。
- プロンプトエンジニアリングを反復している研究者。マネージャーを使用すると、過去のフィードバックをアーカイブして再生できます。
- Herdrを共有AIアシスタントインターフェースとして使用し、セッション間で一貫したアノテーション形式を必要としているチーム。
クイックリファレンスチートシート
# キーバインドの例 (`~/.config/herdr/config.toml` に配置)
[[keys.command]]
key = "prefix+a"
type = "plugin_action"
command = "annotate.capture"
description = "annotate text"
# … READMEの指示に従って残りを追加…
要約: herdr‑annotate は、ターミナルの選択範囲を構造化されたLLM対応フィードバックに変換し、ドキュメント全体をレビューできます。すべてHerdr環境から離れることなく実現します。
関連
- プロジェクト
- プロジェクト
- Dispatch
- プロジェクト
- プロジェクト