docs: add README for every subdirectory

33 agent READMEs, 14 hand READMEs, 2 plugin READMEs (echo-memory + hooks), and 2 skill READMEs (custom-skill-prompt + custom-skill-python). Each README documents the component's purpose, configuration, and usage based on its TOML definition.
2026-03-21 02:27:34 +09:00
1 parent 206169c1d7
commit 4b38372463
@@ -0,0 +1,31 @@
+# Analytics Hand
+
+Autonomous data analytics agent -- data collection, analysis, visualization, dashboards, and automated reporting.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `data` |
+| Agent | `analytics-hand` |
+| Routing | `data analysis`, `data visualization`, `dashboard`, `automated report`, `statistical analysis` |
+
+## Integrations
+
+- **Python 3** -- Required for data analysis with pandas, matplotlib, and seaborn.
+
+## Settings
+
+- **Data Source** -- Primary data source type (`csv`, `json`, `database`, `api`, `web`)
+- **Analysis Type** -- Default analysis approach (`descriptive`, `diagnostic`, `predictive`, `prescriptive`)
+- **Output Format** -- Report format (`report`, `dashboard`, `slides`, `executive`)
+- **Visualization** -- Generate charts and visualizations (default: on)
+- **Scheduled Reports** -- Auto-generate reports on a schedule (default: off)
+- **Report Frequency** -- `daily`, `weekly`, `monthly`
+- **Confidence Threshold** -- Minimum confidence for findings (`low`, `medium`, `high`)
+
+## Usage
+
+```bash
+librefang hand run analytics
+```
@@ -0,0 +1,32 @@
+# API Tester Hand
+
+Autonomous API testing agent -- endpoint discovery, request validation, load testing, and regression detection.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `development` |
+| Agent | `apitester-hand` |
+| Routing | `api test`, `endpoint test`, `load test`, `regression test`, `api discovery` |
+
+## Integrations
+
+None required.
+
+## Settings
+
+- **Base URL** -- Base URL of the API to test
+- **Authentication Type** -- `none`, `bearer`, `api_key_header`, `basic`
+- **Auth Token / API Key** -- Credentials for API authentication
+- **Test Mode** -- `functional`, `regression`, `load`, `security`, `comprehensive`
+- **OpenAPI Spec URL** -- URL to OpenAPI/Swagger spec for auto-discovery
+- **Auto Schedule** -- Run tests on a schedule (default: off)
+- **Test Frequency** -- `hourly`, `daily`, `weekly`
+- **Strict Mode** -- Treat any non-2xx response as failure (default: off)
+
+## Usage
+
+```bash
+librefang hand run apitester
+```
@@ -0,0 +1,30 @@
+# Browser Hand
+
+Autonomous web browser -- navigates sites, fills forms, clicks buttons, and completes multi-step web tasks with user approval for purchases.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `productivity` |
+| Agent | `browser-hand` |
+| Routing | `open website`, `navigate to`, `fill form`, `click button`, `web login`, `browser automation` |
+
+## Integrations
+
+- **Python 3** -- Required for Playwright browser automation library.
+- **Chromium** (optional) -- A Chromium-based browser; Playwright can install its own if none found.
+
+## Settings
+
+- **Headless Mode** -- Run browser without a visible window (default: on)
+- **Purchase Approval** -- Require confirmation before purchases (default: on)
+- **Max Pages Per Task** -- Navigation limit per task (`10`, `20`, `50`)
+- **Default Wait After Action** -- Page settle time (`auto`, `1s`, `3s`)
+- **Screenshot After Actions** -- Auto-screenshot after every action (default: off)
+
+## Usage
+
+```bash
+librefang hand run browser
+```
@@ -0,0 +1,31 @@
+# Clip Hand
+
+Turns long-form video into viral short clips with captions and thumbnails.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `content` |
+| Agent | `clip-hand` |
+| Routing | `clip video`, `video transcription`, `subtitle extraction`, `download video`, `short clip` |
+
+## Integrations
+
+- **FFmpeg** -- Core video processing engine for clips, captions, and thumbnails.
+- **FFprobe** -- Video metadata analyzer (ships with FFmpeg).
+- **yt-dlp** -- Downloads videos from YouTube, Vimeo, Twitter, and 1000+ sites.
+
+## Settings
+
+- **Speech-to-Text Provider** -- `auto`, `whisper_local`, `groq_whisper`, `openai_whisper`, `deepgram`
+- **Text-to-Speech Provider** -- `none`, `edge_tts`, `openai_tts`, `elevenlabs`
+- **Publish Clips To** -- `local_only`, `telegram`, `whatsapp`, `both`
+- **Telegram Bot Token / Chat ID** -- For Telegram publishing
+- **WhatsApp Token / Phone ID / Recipient** -- For WhatsApp publishing
+
+## Usage
+
+```bash
+librefang hand run clip
+```
@@ -0,0 +1,32 @@
+# Collector Hand
+
+Autonomous intelligence collector -- monitors any target continuously with change detection and knowledge graphs.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `data` |
+| Agent | `collector-hand` |
+| Routing | `monitor changes`, `track updates`, `collect intelligence`, `osint`, `change detection` |
+
+## Integrations
+
+None required.
+
+## Settings
+
+- **Target Subject** -- What to monitor (company, person, technology, market, topic)
+- **Collection Depth** -- `surface`, `deep`, `exhaustive`
+- **Update Frequency** -- `hourly`, `every_6h`, `daily`, `weekly`
+- **Focus Area** -- `market`, `business`, `competitor`, `person`, `technology`, `general`
+- **Alert on Changes** -- Publish events on significant changes (default: on)
+- **Report Format** -- `markdown`, `json`, `html`
+- **Max Sources Per Cycle** -- `10`, `30`, `50`, `100`
+- **Track Sentiment** -- Analyze sentiment trends over time (default: off)
+
+## Usage
+
+```bash
+librefang hand run collector
+```
@@ -0,0 +1,32 @@
+# DevOps Hand
+
+Autonomous DevOps engineer -- CI/CD management, infrastructure monitoring, deployment automation, and incident response.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `development` |
+| Agent | `devops-hand` |
+| Routing | `ci/cd`, `pipeline`, `github actions`, `infrastructure monitoring`, `deployment automation`, `incident response` |
+
+## Integrations
+
+None required.
+
+## Settings
+
+- **Infrastructure Type** -- `cloud`, `kubernetes`, `docker`, `bare_metal`, `serverless`
+- **CI/CD Platform** -- `github_actions`, `gitlab_ci`, `jenkins`, `circleci`, `other`
+- **Monitoring Focus** -- `uptime`, `performance`, `security`, `cost`, `balanced`
+- **Auto Monitor** -- Automatically monitor infrastructure (default: off)
+- **Health Check Interval** -- `1min`, `5min`, `15min`, `1hour`
+- **Service URLs** -- Comma-separated URLs to monitor
+- **Alert on Failure** -- Publish events on health check failures (default: on)
+- **Rollback Strategy** -- `manual`, `auto_previous`, `blue_green`
+
+## Usage
+
+```bash
+librefang hand run devops
+```
@@ -0,0 +1,33 @@
+# Lead Hand
+
+Autonomous lead generation -- discovers, enriches, and delivers qualified leads on a schedule.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `data` |
+| Agent | `lead-hand` |
+| Routing | `lead generation`, `prospect list`, `find customers`, `contact enrichment` |
+
+## Integrations
+
+None required.
+
+## Settings
+
+- **Target Industry** -- Industry vertical to focus on
+- **Target Role** -- Decision-maker titles to target
+- **Company Size** -- `any`, `startup`, `smb`, `enterprise`
+- **Lead Source** -- `web_search`, `linkedin_public`, `crunchbase`, `custom`
+- **Output Format** -- `csv`, `json`, `markdown_table`
+- **Leads Per Report** -- `10`, `25`, `50`, `100`
+- **Delivery Schedule** -- `daily_7am`, `daily_9am`, `weekdays_8am`, `weekly_monday`
+- **Geographic Focus** -- Region to prioritize
+- **Enrichment Depth** -- `basic`, `standard`, `deep`
+
+## Usage
+
+```bash
+librefang hand run lead
+```
@@ -0,0 +1,32 @@
+# LinkedIn Hand
+
+Autonomous LinkedIn manager -- profile optimization, content creation, networking, and professional engagement.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `communication` |
+| Agent | `linkedin-hand` |
+| Routing | `linkedin`, `profile optimization`, `professional networking` |
+
+## Integrations
+
+- **LINKEDIN_ACCESS_TOKEN** -- OAuth 2.0 access token from the LinkedIn Developer Portal.
+
+## Settings
+
+- **Content Style** -- `thought_leader`, `educational`, `storyteller`, `data_driven`, `conversational`
+- **Post Frequency** -- `1_weekly`, `3_weekly`, `5_weekly`, `1_daily`
+- **Content Topics** -- Comma-separated topics to create content about
+- **Auto Engage** -- Automatically like/comment on relevant posts (default: off)
+- **Approval Mode** -- Queue posts for review before posting (default: on)
+- **Hashtag Count** -- `0`, `3`, `5`
+- **Target Audience** -- `peers`, `recruiters`, `clients`, `general`
+- **Language** -- `en`, `zh`, `es`, `auto`
+
+## Usage
+
+```bash
+librefang hand run linkedin
+```
@@ -0,0 +1,32 @@
+# Predictor Hand
+
+Autonomous future predictor -- collects signals, builds reasoning chains, makes calibrated predictions, and tracks accuracy.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `data` |
+| Agent | `predictor-hand` |
+| Routing | `predict`, `forecast`, `probability`, `likelihood`, `scenario analysis` |
+
+## Integrations
+
+None required.
+
+## Settings
+
+- **Prediction Domain** -- `tech`, `finance`, `geopolitics`, `climate`, `general`
+- **Time Horizon** -- `1_week`, `1_month`, `3_months`, `1_year`
+- **Data Sources** -- `news`, `social`, `financial`, `academic`, `all`
+- **Report Frequency** -- `daily`, `weekly`, `biweekly`, `monthly`
+- **Predictions Per Report** -- `3`, `5`, `10`, `20`
+- **Track Accuracy** -- Score past predictions when they expire (default: on)
+- **Confidence Threshold** -- `low` (20%+), `medium` (40%+), `high` (70%+)
+- **Contrarian Mode** -- Seek counter-consensus predictions (default: off)
+
+## Usage
+
+```bash
+librefang hand run predictor
+```
@@ -0,0 +1,34 @@
+# Reddit Hand
+
+Autonomous Reddit manager -- monitors subreddits, posts content, replies to threads, and tracks karma and engagement.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `communication` |
+| Agent | `reddit-hand` |
+| Routing | `reddit`, `subreddit`, `reddit post`, `reddit monitor` |
+
+## Integrations
+
+- **REDDIT_CLIENT_ID** -- OAuth2 client ID from a Reddit app.
+- **REDDIT_CLIENT_SECRET** -- OAuth2 client secret from a Reddit app.
+- **REDDIT_USERNAME** -- Reddit account username.
+- **REDDIT_PASSWORD** -- Reddit account password.
+
+## Settings
+
+- **Subreddits** -- Comma-separated list of subreddits to monitor
+- **Monitor Mode** -- `hot_only`, `new_only`, `hot_and_new`, `rising`
+- **Auto Reply** -- Automatically reply to relevant posts (default: off)
+- **Post Frequency** -- `never`, `1_daily`, `3_daily`, `weekly`
+- **Content Style** -- `helpful`, `casual`, `expert`, `witty`
+- **Approval Mode** -- Queue posts for review (default: on)
+- **Max Reply Depth** -- `1`, `3`, `5`, `unlimited`
+
+## Usage
+
+```bash
+librefang hand run reddit
+```
@@ -0,0 +1,32 @@
+# Researcher Hand
+
+Autonomous deep researcher -- exhaustive investigation, cross-referencing, fact-checking, and structured reports.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `productivity` |
+| Agent | `researcher-hand` |
+| Routing | `deep research`, `systematic review`, `landscape analysis`, `exhaustive investigation` |
+
+## Integrations
+
+None required.
+
+## Settings
+
+- **Research Depth** -- `quick` (5-10 sources), `thorough` (20-30), `exhaustive` (50+)
+- **Output Style** -- `brief`, `detailed`, `academic`, `executive`
+- **Source Verification** -- Cross-check claims across multiple sources (default: on)
+- **Max Sources** -- `10`, `30`, `50`, `unlimited`
+- **Auto Follow-Up** -- Research follow-up questions discovered during investigation (default: on)
+- **Save Research Log** -- Save detailed search queries and source notes (default: off)
+- **Citation Style** -- `inline_url`, `footnotes`, `academic_apa`, `numbered`
+- **Language** -- `english`, `spanish`, `french`, `german`, `chinese`, `japanese`, `auto`
+
+## Usage
+
+```bash
+librefang hand run researcher
+```
@@ -0,0 +1,32 @@
+# Strategist Hand
+
+Autonomous strategy analyst -- market research, competitive analysis, business planning, and strategic recommendations.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `productivity` |
+| Agent | `strategist-hand` |
+| Routing | `strategic analysis`, `competitive analysis`, `business plan`, `market research` |
+
+## Integrations
+
+None required.
+
+## Settings
+
+- **Focus Area** -- `general`, `market_entry`, `competitive`, `product`, `growth`
+- **Analysis Depth** -- `quick`, `thorough`, `comprehensive`
+- **Industry** -- Primary industry to focus on
+- **Key Competitors** -- Comma-separated list of competitors to track
+- **Auto Monitor** -- Track competitor moves automatically (default: off)
+- **Report Format** -- `executive`, `detailed`, `slide_deck`, `memo`
+- **Confidence Threshold** -- `low`, `medium`, `high`
+- **Preferred Frameworks** -- e.g. `SWOT`, `Porter`, `PESTEL`
+
+## Usage
+
+```bash
+librefang hand run strategist
+```
@@ -0,0 +1,34 @@
+# Trading Hand
+
+Autonomous market intelligence and trading engine -- multi-signal analysis, adversarial bull/bear reasoning, calibrated confidence scoring, strict risk management, and portfolio-level analytics.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `data` |
+| Agent | `trader-hand` |
+| Routing | `trade`, `portfolio`, `market analysis`, `paper trade`, `stock trading` |
+
+## Integrations
+
+None required. Alpaca API keys needed for live trading mode.
+
+## Settings
+
+- **Trading Mode** -- `analysis` (signals only), `paper` (simulated), `live` (real via Alpaca)
+- **Market Focus** -- `us_stocks`, `crypto`, `multi_asset`
+- **Strategy Style** -- `scalping`, `day`, `swing`, `position`
+- **Risk Per Trade** -- `1%`, `2%`, `3%`, `5%` of portfolio
+- **Max Daily Loss** -- `2%`, `5%`, `10%` circuit breaker threshold
+- **Analysis Depth** -- `quick`, `standard`, `deep`
+- **Scan Schedule** -- `15m`, `1h`, `4h`, `daily`
+- **Watchlist** -- Comma-separated tickers (default: `SPY,QQQ,AAPL,MSFT,NVDA,BTC,ETH`)
+- **Initial Capital** -- Starting portfolio value (default: `$10,000`)
+- **Approval Mode** -- Require approval before live trades (default: on)
+
+## Usage
+
+```bash
+librefang hand run trader
+```
@@ -0,0 +1,34 @@
+# Twitter Hand
+
+Autonomous Twitter/X manager -- content creation, scheduled posting, engagement, and performance tracking.
+
+## Configuration
+
+| Field | Value |
+|-------|-------|
+| Category | `communication` |
+| Agent | `twitter-hand` |
+| Routing | `twitter`, `tweet`, `x.com`, `scheduled tweet` |
+
+## Integrations
+
+- **TWITTER_BEARER_TOKEN** -- Bearer Token from the Twitter/X Developer Portal.
+
+## Settings
+
+- **Content Style** -- `professional`, `casual`, `witty`, `educational`, `provocative`, `inspirational`
+- **Post Frequency** -- `1_daily`, `3_daily`, `5_daily`, `hourly`
+- **Auto Reply** -- Reply to mentions automatically (default: off)
+- **Auto Like** -- Like relevant tweets automatically (default: off)
+- **Content Topics** -- Comma-separated topics
+- **Brand Voice** -- Description of your unique voice
+- **Thread Mode** -- Include multi-tweet threads (default: on)
+- **Content Queue Size** -- `5`, `10`, `20`, `50`
+- **Engagement Hours** -- `business_hours`, `waking_hours`, `all_day`
+- **Approval Mode** -- Queue tweets for review (default: on)
+
+## Usage
+
+```bash
+librefang hand run twitter
+```