Skip to content

README.md

Latest commit

 

History

History
55 lines (41 loc) · 3.34 KB

README.md

File metadata and controls

55 lines (41 loc) · 3.34 KB

Wiki Search - Alfred Workflow

Search Wikipedia articles from Alfred and open selected pages in your browser.

Screenshot

Wiki Search workflow screenshot

Features

  • Trigger wiki search with wk <query>.
  • Show article title and cleaned snippet directly in Alfred.
  • Open selected Wikipedia article URL in your default browser with Enter.
  • Current language row is always pinned to the first item.
  • Language switch rows list all configured languages in WIKI_LANGUAGE_OPTIONS order (for example zh,en keeps zh then en).
  • Press Enter on a language row to directly requery the same keywords in that language.
  • Short query guard: <2 characters shows Keep typing (2+ chars) and skips API calls.
  • Script Filter queue policy: 1 second delay with initial immediate run disabled.
  • Default typing debounce comes from Alfred's 1 second Script Filter queue delay; same-query cache stays opt-in and shared coalescing can be re-enabled via runtime variables.
  • Runtime orchestration is shared via scripts/lib/script_filter_search_driver.sh; Wikipedia-specific fetch/error mapping remains local.
  • Map common failures (invalid config, API unavailable) to actionable Alfred messages.
  • Tune language and result count through workflow variables.

Configuration

Set these via Alfred's "Configure Workflow..." UI:

Variable Required Default Description
WIKI_LANGUAGE No en Optional lowercase Wikipedia language code. Effective format is clamped to ^[a-z]{2,12}$.
WIKI_LANGUAGE_OPTIONS No zh,en Optional comma/newline list of switch-row languages. Row order follows this config exactly.
WIKI_MAX_RESULTS No 10 Max results per query. Effective range is clamped to 1..20.

Keyword

Keyword Behavior
wk <query> Search and list Wikipedia articles, then open selected URL.

Advanced Runtime Parameters

Parameter Description
WIKI_CLI_BIN Optional override path for wiki-cli (useful for local debugging).
WIKI_REQUERY_COMMAND Optional override command used by action_open.sh to trigger requery (test/debug helper).
WIKI_QUERY_CACHE_TTL_SECONDS Optional same-query cache TTL (seconds). Default 0 (disabled to avoid stale mid-typing hits).
WIKI_QUERY_COALESCE_SETTLE_SECONDS Optional coalesce settle window (seconds). Default 0 so pasted/final queries do not wait twice.
WIKI_QUERY_COALESCE_RERUN_SECONDS Optional Alfred rerun interval while waiting for coalesced result. Default 0.4.

Troubleshooting

See TROUBLESHOOTING.md.
⚡