Documentation Index
Fetch the complete documentation index at: https://docs.feral.sh/llms.txt
Use this file to discover all available pages before exploring further.

What FERAL is
FERAL is a local-first brain you install on your machine. It sits in the middle of your software and physical devices, so one runtime can keep context, apply policy, and execute actions. Core model:- 4-layer memory: working context, episodic events, semantic/graph retrieval, and execution history.
- Baseline learning: rolling metrics + anomaly/trend detection for what “normal” looks like.
- Digital twin actions: policy-gated autonomy with approvals, time windows, and daily caps.
- Publisher workflow: developers ship headless API/CLI contracts + app manifests; FERAL renders structured Gen-UI surfaces.
- Org review gate: submitted registry apps are not user-installable until approved by FERAL reviewers.
What it can do now
- Coordinate actions across chat, tools, channels, and connected devices from one runtime.
- Keep persistent memory, baseline state, and execution history in your local FERAL home.
- Pair phones and browser nodes over LAN or remote tunnel modes.
- Render server-driven UI (Gen-UI/SDUI) as structured components in the web client.
- Enforce explicit action paths (including approval gates where configured).
Connectivity model
FERAL has three pairing/access modes:- Same WiFi (
local): pair from phone when both devices share a network. - Anywhere (
remote): pair/use through Tailscale Funnel. - This Mac only (
localhost): no phone pairing yet.
Gen-UI in one paragraph
Gen-UI is server-driven UI. The brain emits structured UI payloads and patches; the client renders supported components. This is controlled, contract-based rendering, not arbitrary HTML generation.Start here
Quickstart
PyPI-first install, first run, and first pairing flow.
Pairing & Access
Same WiFi vs Anywhere, with exact commands and failure recovery.
Gen-UI Guide
What SDUI does in this repo and where the current limits are.
Architecture
Runtime components and how requests flow through the brain.