Quick start
- Download the archive for your platform from the latest release.
- Extract the archive.
- Start Vifu:
- Install the optimized Android Starter APK. You can also build the Starter from source.
Vifu creates a local Runtime profile and opens the Runtime TUI. It stores local
state in SQLite under ~/.vifu.
Press B to open the Dashboard. The default Dashboard address is
http://127.0.0.1:6790. Vifu continues to serve requests until you stop the
TUI.
Pair the Android Starter with Vifu to inspect its inference stages. Install the baseline APK beside the optimized APK. Pair both applications with the same Vifu project to compare their traces on one device. Use a new one-time pairing code for each application. For iOS and other integrations, use the examples guide.
Description
Vifu gives products stable endpoints for local and remote AI Agents. Product code owns the state, UI, safety rules, and allowed actions.
Vifu manages the provider connections, Agents, endpoints, sessions, keys, routes, and traces for each App.
- Connect local or external Providers to named endpoints.
- Call endpoints through an OpenAI-compatible HTTP API.
- Inspect Agents and traces in the TUI or Console.
- Embed the Rust Runtime in an application.
- Connect an embedded Runtime to a Server through Agent Gateway.
- Import or export Project Settings as JSON.
Available surfaces
| Surface | Distribution | Start here |
|---|---|---|
| Local Server and embedded Console | Release binary | Install or Embedded Console |
| Self-host Server and Console | Docker Compose | Self-host |
| Agent Providers | Built-in and configurable adapters | Provider integrations |
| Rust embedding | crates.io package | Embed the Runtime |
| Swift on iOS/macOS | SwiftPM package | Apple application guide |
| Android Starter | Release APK and Kotlin source project | Android Starter |
| iOS Starter | SwiftUI source and optional TestFlight beta | iOS Starter |
| Godot in an Apple host | VifuGodot SwiftPM package | VifuGodot guide |
| Kotlin/Android | Modular Core, llama, and Whisper ARM64 Maven AARs | Android Starter |
Documentation
Use Vifu
- Install Vifu
- Apps and App IDs
- Runtime topology and Gateway enrollment
- Embedded Console
- ARM optimization TUI
- Self-host with Docker
- Project Settings
- Provider integrations
- Local llama Provider
- Local Whisper Provider
Embed Vifu
- Embed the Runtime
- vifu-runtime API
- vifu-gateway
- VifuGodot for Apple hosts
- Mobile FFI for Apple and Android hosts
- Runnable examples and mobile starters
- Android Starter
- iOS Starter
- Godot iOS Starter
- Android AAR reference
Development
Vifu is licensed under Apache-2.0. The license does not grant rights to the Vifu name and logos. See TRADEMARKS.md.