Skip to main content

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.

​
Quickstart

​
1) Install and start

pip install "feral-ai[all]"
feral setup
feral start
Open http://localhost:9090.

​
2) Choose your access mode during setup

In the setup wizard’s Pair your phone step, pick one:
  • Same WiFi: phone and Mac are on the same network.
  • Anywhere: phone can connect outside your LAN through Tailscale Funnel.
  • This Mac only: skip phone pairing for now.

​
3) Pair from the Devices page

  1. Open Devices.
  2. Click Pair new device.
  3. Use the Web phone tab and click Generate one-time link.
  4. Scan the QR on your phone and finish the /pair flow.
If PIN is enabled, enter the 4-digit PIN shown in the modal.

​
4) Anywhere mode (UI-first + CLI fallback)

Setup now attempts to enable Anywhere automatically. If setup reports a tunnel error, run: 
feral access remote-up
You can also toggle this later from Settings -> Access in the v2 UI. Check status: 
feral access status
Turn remote mode off: 
feral access remote-down

​
5) If LAN URLs fail from phone

If a generated LAN URL works on the Mac but fails on phone, restart bound to all interfaces: 
FERAL_HOST=0.0.0.0 feral start
Also verify your WiFi does not block client-to-client traffic (AP isolation).

​
Next