felo-livedoc について
felo-livedoc は、LiveDoc のナレッジベース、リソース、タスクを管理するスキルです。文書の整理やセマンティック検索に加え、README、リソースの特定、タスクコメントも扱えます。
主な機能
- 01LiveDoc の作成と管理
- 02リソースの追加・表示・削除
- 03リソースのセマンティック検索
- 04README とタスクの管理
- 05タスク記録の表示とコメント追加
活用シーン
- 01文書やウェブリソースの整理
- 02リソースから関連内容を検索
- 03タスクの追跡とコメントの記録
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ felo-inc/ felo-skills --skill felo-livedocインストール後、Claude Code で/felo-livedocを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
clawhub.jsonLICENSEREADME.mdscripts/run_livedoc.mjs詳細
Felo LiveDoc スキル
使用するタイミング
ユーザーが次の操作を希望したときに、このスキルを起動します。
- ナレッジベースの作成/管理: LiveDoc の作成、一覧表示、更新、削除
- リソースの追加: LiveDoc へのドキュメントのアップロード、URL の追加、テキストドキュメントの作成
- セマンティック検索: 自然言語のクエリを使ってナレッジベース内のリソースを検索
- リソースの振り分け: クエリを使って関連するリソース ID を見つけ、対象を絞って検索
- リソース管理: LiveDoc 内のリソースの一覧表示、表示、削除
- README の管理: LiveDoc の README の取得、作成、更新、追記、削除
- タスク管理: タスクの作成、更新、削除、コメントの追加、変更履歴の表示
トリガーとなる語句:
- English: knowledge base, livedoc, live doc, upload document, add URL, semantic search, retrieve, knowledge retrieval, route resources, readme, task, task management, comment
- 简体中文: 知識ベース、ドキュメントライブラリ、ドキュメントのアップロード、リンクの追加、セマンティック検索、知識検索、タスク、タスク管理、コメント
明示的なコマンド: /felo-livedoc、"livedoc"、"felo livedoc"
次の場合は使用しないでください:
- 一般的なウェブ検索(felo-search を使用)
- PPT の生成(felo-slides を使用)
- SuperAgent との会話(felo-superAgent を使用)
セットアップ
1. API キーを取得する
- felo.ai にアクセスしてログイン(または登録)します
- 右上のアバターをクリックし、[Settings]を選択します
- [API Keys]タブに移動します
- [Create New Key]をクリックして、新しい API Key を生成します
- API Key をコピーし、安全な場所に保存します
2. API キーを設定する
FELO_API_KEY 環境変数を設定します。
Linux/macOS:
export FELO_API_KEY="your-api-key-here"
Windows (PowerShell):
$env:FELO_API_KEY="your-api-key-here"
実行方法
このスキルが起動したら、Bash ツールを使って livedoc スクリプトを実行します。
LiveDoc の管理
LiveDoc を作成:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs create --name "KB Name" --description "Description"
LiveDoc を一覧表示:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs list
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs list --keyword "search term"
LiveDoc を更新:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs update SHORT_ID --name "New Name" --description "New Desc"
LiveDoc を削除:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs delete SHORT_ID
リソース管理
テキストドキュメントを追加:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs add-doc SHORT_ID --title "Doc Title" --content "Document content here"
URL を追加(最大 10 件、カンマ区切り):
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs add-urls SHORT_ID --urls "https://example.com,https://example.org"
各 URL は、--url-titles オプションを使って url:title のペアとして渡すことも、JSON 配列として渡すこともできます。API はプレーンな文字列と {"url": "...", "title": "..."} オブジェクトの両方を受け付けます。--json モードでは、スクリプトはそのまま API に渡します。カスタムタイトル付きで URL を追加するには、JSON フラグを使用してリクエスト本文を手動で作成するか、ページから自動取得されたタイトルを使用してください。
ファイルをアップロード:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs upload SHORT_ID --file ./document.pdf
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs upload SHORT_ID --file ./document.pdf --convert
リソースを一覧表示:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs resources SHORT_ID
単一のリソースを取得:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs resource SHORT_ID RESOURCE_ID
リソースを削除:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs remove-resource SHORT_ID RESOURCE_ID
リソースを更新(タイトル/スニペット/サムネイル):
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs update-resource SHORT_ID RESOURCE_ID --title "New Title"
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs update-resource SHORT_ID RESOURCE_ID --snippet "New summary" --thumbnail "https://example.com/thumb.png"
リソースのコンテンツを更新(ai_doc タイプのみ。先頭 2000 バイトからスニペットも自動更新):
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs update-resource-content SHORT_ID RESOURCE_ID --content "New content here"
セマンティック検索
クエリで関連するリソースを振り分け:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs route SHORT_ID --query "your search query"
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs route SHORT_ID --query "your search query" --max-resources 5
すべてのリソースを検索(自動振り分け):
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs retrieve SHORT_ID --query "your search query"
特定のリソース内を検索:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs retrieve SHORT_ID --query "your search query" --resource-ids "id1,id2,id3"
リソースのファイルとコンテンツ
リソースのソースファイルをダウンロード(署名付き URL を取得):
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs download SHORT_ID RESOURCE_ID
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs download SHORT_ID RESOURCE_ID --expires-in 7200
リソースから抽出したテキストコンテンツを取得:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs content SHORT_ID RESOURCE_ID
PPT ページの詳細検索:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs ppt-retrieve SHORT_ID --resource-id RESOURCE_ID --page-number 3 --query "pricing information"
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs ppt-retrieve SHORT_ID --resource-id RESOURCE_ID --page-number 3 --query "pricing information" --max-chunk 5
README の管理
README を取得:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs get-readme SHORT_ID
README を作成または置換:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs update-readme SHORT_ID --content "# My KB\n\nThis is the README."
README に追記:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs append-readme SHORT_ID --content "\n\n## New Section\n\nAdditional content."
README を削除:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs delete-readme SHORT_ID
タスク管理
タスクを一覧表示(任意のフィルターを指定可能):
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs tasks SHORT_ID
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs tasks SHORT_ID --status 0
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs tasks SHORT_ID --labels "docs,priority-high"
タスクを作成:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs create-task SHORT_ID --title "Write docs" --status 0 --sort 0
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs create-task SHORT_ID --title "Write docs" --status 0 --sort 0 --description "API docs" --labels "docs"
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs create-task SHORT_ID --title "Write docs" --operated-by "claude-code"
タスクのステータス値:0=TODO、1=IN_PROGRESS、2=DONE
タスクを更新(部分更新):
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs update-task SHORT_ID TASK_ID --status 1
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs update-task SHORT_ID TASK_ID --title "New title" --labels "docs,done"
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs update-task SHORT_ID TASK_ID --status 2 --operated-by "claude-code"
タスクを削除:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs delete-task SHORT_ID TASK_ID
タスクの記録(コメントと変更履歴)を一覧表示:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs task-records SHORT_ID TASK_ID
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs task-records SHORT_ID TASK_ID --record-type comment
タスクにコメントを追加:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs add-task-comment SHORT_ID TASK_ID --content "This is a comment."
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs add-task-comment SHORT_ID TASK_ID --content "This is a comment." --operated-by "claude-code"
オプション
すべてのコマンドで次のオプションを使用できます。
--jsonまたは-j— 生の JSON レスポンスを出力します--timeout <ms>または-t <ms>— リクエストのタイムアウトをミリ秒単位で指定します(デフォルト:60000)
レスポンスの解析とフォーマット
API は次の構造の JSON を返します。
{
"status": "ok",
"message": "success",
"data": { ... }
}
LiveDoc オブジェクト:
short_id— 一意の識別子(すべての操作で使用します)name— LiveDoc の名前description— LiveDoc の説明is_shared— この LiveDoc が共有されたものである(自分が所有していない)場合はtruecreated_at/modified_at— タイムスタンプ
リソースオブジェクト:
id— リソース識別子title— リソースのタイトルresource_type— 種類(web、ai_doc、file など)status— 処理ステータスsnippet— コンテンツのプレビュー
取得結果:
id— リソース IDtitle— リソースのタイトルcontent— 一致したコンテンツscore— 関連度スコア(0-1)
エラー処理
一般的なエラーコード
INVALID_API_KEY— API Key が無効または取り消されていますLIVEDOC_NOT_FOUND— LiveDoc が存在しませんLIVEDOC_RESOURCE_NOT_FOUND— リソースが存在しませんLIVEDOC_CREATE_FAILED— LiveDoc の作成に失敗しましたLIVEDOC_RESOURCE_UPLOAD_FAILED— ファイルのアップロードに失敗しましたLIVEDOC_RESOURCE_ADD_URLS_FAILED— URL の追加に失敗しましたLIVEDOC_RESOURCE_RETRIEVE_FAILED— セマンティック検索に失敗しましたLIVEDOC_README_GET_FAILED— README の取得に失敗しましたLIVEDOC_README_UPDATE_FAILED— README の作成または更新に失敗しましたLIVEDOC_README_DELETE_FAILED— README の削除に失敗しましたLIVEDOC_TASK_LIST_FAILED— タスクの一覧表示に失敗しましたLIVEDOC_TASK_CREATE_FAILED— タスクの作成に失敗しましたLIVEDOC_TASK_UPDATE_FAILED— タスクの更新に失敗しましたLIVEDOC_TASK_DELETE_FAILED— タスクの削除に失敗しましたLIVEDOC_TASK_NOT_FOUND— タスクが存在しませんLIVEDOC_TASK_RECORD_LIST_FAILED— タスクレコードの一覧表示に失敗しましたLIVEDOC_TASK_COMMENT_CREATE_FAILED— コメントの追加に失敗しました
API キーが設定されていない場合
FELO_API_KEY が設定されていない場合は、次のメッセージを表示します。
ERROR: FELO_API_KEY not set. Get your API key from https://felo.ai (Settings → API Keys).
Set it with: export FELO_API_KEY="your-key"
重要な注意事項
- LiveDoc を参照するときは、必ず create/list から返された
short_idを使用してください - URL リソースは、1 リクエストあたり 10 件までです
- ファイルを検索可能なドキュメントに変換するには、アップロード時に
--convertを使用してください - セマンティック検索では、関連度スコアの高い順に結果が返されます
- Bash ツールを使用してすぐに実行してください。実行する内容を説明するだけにしないでください