Shared crates for the xfetch ecosystem.

The current release line is 0.3.1. It keeps the JSON protocol at version 1 and the WIT at xfetch:[email protected]; the changes are additive.

• crates/common (xfetch-api-common): shared protocol constants, frame shape, timeout and JSON IO helpers.
• crates/plugin-api: shared protocol crate for xfetch plugins.
• crates/extension-api: shared protocol crate for xfetch extensions (config providers).
• crates/effect-api: shared protocol crate for xfetch effects (intro animations over the info lines).
• crates/guest-api: host-call helpers for WebAssembly guests (http_request, exec, log, protocol_version).
• crates/command-api: shared protocol crate for CLI command addons.
• wit/xfetch-runtime.wit: component-model contract (plugin, effect, extension and command worlds).
• docs/: focused documentation for setup, protocol, SDK usage, wasm guests, and examples.
• crates/*/examples/: minimal plugin, effect and extension binaries that compile against the public crates.

The first public crate in this repository is xfetch-plugin-api.

• Defines the wire protocol used between xfetch and plugins.
• Provides typed helpers for reading requests and writing responses.
• Exposes a stable base for official and third-party plugin development.

crates/effect-api (xfetch-effect-api) is the contract for effects: installable intro animations. The core renders the info lines and sends them to an effect binary (xfetch-effect-<name>); the effect returns a sequence of frames (delay + transformed lines) that the core plays before settling on the final content. Effect implementations are collected in the xfetch-cli/effects repository (the reference decrypt effect lives there).

• Request carries the rendered lines plus style, duration_ms, fps and free-form args.
• Response is a non-empty list of EffectFrame { delay_ms, lines }.
• Effects are opt-in: a missing binary or invalid response simply skips the intro (no behavior change).

crates/command-api (xfetch-command-api) is the contract for CLI command addons. Commands receive arguments and return plain text lines, so a command owns its own output format. Components use the command world in the WIT package; core modules use the JSON request on stdin and plain text on stdout.

• Documentation Index
• Getting Started
• Plugin SDK
• Protocol Reference
• Extension SDK
• Effect SDK
• Command SDK
• Examples

• This repository owns shared contracts, not end-user config files.
• Official plugins are expected to use the same public SDK as external plugins.
• Protocol changes should land here first and then be adopted by the core and plugin repos.
• Publishing order: xfetch-api-common first, then xfetch-plugin-api, xfetch-extension-api, xfetch-effect-api and xfetch-command-api; xfetch-guest-api is independent.