# hikyaku

> hikyaku (飛脚) is a message relay written in Go and configured with one YAML spec (hikyaku.yaml). It reads from one or more endpoints and delivers to one or more endpoints: sources (listen, poll, subscribe) over http/https, ws/wss, sse, stdin and file; destinations over the same protocols plus stdout, stderr, groups and a fault-injecting test sink. Routes pick destinations with a static, rules (CEL), sticky or AI router; the AI router runs on Genkit Go, with System One decision models (typed answers, calibrated probabilities) by default and any generative model as an alternative, and can route with the history of past calls kept in Redis. Every layer retries and falls back: destination retries, breakers, retry budgets, fallback chains, groups, hedging, model and router fallbacks, and a dead-letter queue with replay. One binary runs as a CLI, a container image and a Helm chart.

Auto-generated from the hikyaku documentation. The spec reference page is generated from the Go structs, and the JSON Schema of hikyaku.yaml is served next to these files at schema/hikyaku.schema.json.

## Documentation

- [Overview](https://xavidop.github.io/hikyaku/docs)
- [Install](https://xavidop.github.io/hikyaku/docs/install)
- [Quick start](https://xavidop.github.io/hikyaku/docs/quickstart)
- [Concepts](https://xavidop.github.io/hikyaku/docs/concepts)
- [The spec (hikyaku.yaml)](https://xavidop.github.io/hikyaku/docs/spec)
- [Spec reference (YAML)](https://xavidop.github.io/hikyaku/docs/spec-reference)
- [Protocols](https://xavidop.github.io/hikyaku/docs/protocols)
- [Routing and the AI router](https://xavidop.github.io/hikyaku/docs/routing)
- [History-aware routing](https://xavidop.github.io/hikyaku/docs/history)
- [Retries and fallbacks](https://xavidop.github.io/hikyaku/docs/resilience)
- [Transforms](https://xavidop.github.io/hikyaku/docs/transforms)
- [CLI reference](https://xavidop.github.io/hikyaku/docs/cli)
- [Deploy (Docker, Helm)](https://xavidop.github.io/hikyaku/docs/deploy)
- [Observability](https://xavidop.github.io/hikyaku/docs/observability)
- [Security](https://xavidop.github.io/hikyaku/docs/security)
- [Examples](https://xavidop.github.io/hikyaku/docs/examples)
- [Contributing](https://xavidop.github.io/hikyaku/docs/contributing)
- [Benchmarks](https://xavidop.github.io/hikyaku/docs/benchmarks)
- [Buffering, ordering and batching](https://xavidop.github.io/hikyaku/docs/delivery)
- [Embed it (Go)](https://xavidop.github.io/hikyaku/docs/library)
- [LLM proxy](https://xavidop.github.io/hikyaku/docs/llm-proxy)
- [Plugins](https://xavidop.github.io/hikyaku/docs/plugins)

## Full text

- [Complete documentation](https://xavidop.github.io/hikyaku/llms-full.txt): every page above concatenated into a single Markdown file.

## Schema

- [hikyaku.schema.json](https://xavidop.github.io/hikyaku/schema/hikyaku.schema.json): the JSON Schema of hikyaku.yaml.