Skip to content

Commit 2933316

Browse files
authored
docs: Update README.md
1 parent 22780e7 commit 2933316

1 file changed

Lines changed: 17 additions & 30 deletions

File tree

README.md

Lines changed: 17 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
# ZeroClaw-Android: Run AI Agents 24/7 on Your Phone
1+
# PhoneClaw: Run AI Agents 24/7 on Your Phone
22

33
![Legacy PhoneClaw Logo](assets/phoneclaw-legacy-logo.png)
44

55
> Your old phone in a drawer is a better AI server than you think.
66
7-
[![CI](https://github.com/Natfii/ZeroClaw-Android/actions/workflows/ci.yml/badge.svg)](https://github.com/Natfii/ZeroClaw-Android/actions/workflows/ci.yml)
87
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
98
[![API 26+](https://img.shields.io/badge/API-26%2B-brightgreen.svg)](https://developer.android.com/about/versions/oreo)
109
[![Latest Release](https://img.shields.io/github/v/release/0xboji/PhoneClaw?include_prereleases&label=release)](https://github.com/0xboji/PhoneClaw/releases)
1110
[![Kotlin](https://img.shields.io/badge/Kotlin-2.0-7F52FF.svg?logo=kotlin&logoColor=white)](https://kotlinlang.org)
1211
[![Rust](https://img.shields.io/badge/Rust-stable-DEA584.svg?logo=rust&logoColor=white)](https://www.rust-lang.org)
13-
[![Providers](https://img.shields.io/badge/Providers-32%2B-blue.svg)](https://github.com/Natfii/ZeroClaw-Android#supported-providers)
12+
[![Providers](https://img.shields.io/badge/Providers-32%2B-blue.svg)](https://github.com/0xboji/PhoneClaw-Android#supported-providers)
1413

15-
ZeroClaw-Android turns your Android phone into an always-on AI agent host. Not a Termux hack. Not a WebView. Native Rust compiled to ARM. Connect to 32+ providers -- OpenAI, Claude, Gemini, Groq, DeepSeek, Ollama, LM Studio, vLLM, Novita, Telnyx, and more -- and run autonomous agents around the clock with encrypted API key storage (AES-256-GCM) and a battery-optimized foreground service. No server required. No cloud bills. Just your phone.
14+
PhoneClaw turns your Android phone into an always-on AI agent host. Not a Termux hack. Not a WebView. Native Rust compiled to ARM. Connect to 32+ providers -- OpenAI, Claude, Gemini, Groq, DeepSeek, Ollama, LM Studio, vLLM, Novita, Telnyx, and more -- and run autonomous agents around the clock with encrypted API key storage (AES-256-GCM) and a battery-optimized foreground service. No server required. No cloud bills. Just your phone.
1615

1716
## Quick Start
1817

@@ -25,7 +24,7 @@ Got an old phone? Give it a new job.
2524

2625
The onboarding wizard walks you through all of this on first launch.
2726

28-
***Disclaimer: This app is a personal project not associated with the ZeroClaw Labs team. It might break.***
27+
***Disclaimer: This app is a personal project not associated with the PhoneClaw Labs team. It might break.***
2928

3029
## Features
3130

@@ -36,13 +35,13 @@ The onboarding wizard walks you through all of this on first launch.
3635
- **Battery-optimized** -- `START_STICKY` foreground service with OEM battery killer detection, auto-restart on boot, network transition handling
3736
- **Material You** -- dynamic color theming on Android 12+, adaptive navigation (bottom bar / rail / drawer), WCAG 2.2 AA accessibility
3837
- **Auto-restart** -- your agents survive reboot, survive task kill, survive sleep. Exponential backoff on failures.
39-
- **Rust core** -- ZeroClaw's router runs natively via UniFFI, with `catch_unwind` at every FFI boundary. No JNI crashes.
38+
- **Rust core** -- PhoneClaw's router runs natively via UniFFI, with `catch_unwind` at every FFI boundary. No JNI crashes.
4039

4140
<!-- <img src="https://github.com/user-attachments/assets/9712875d-5650-43a4-9646-8aa4d4175291" alt="On Boarding" width="30%" /> <img src="https://github.com/user-attachments/assets/ae198cdc-2130-4b25-8e69-114468653777" alt="Nav" width="37.5%" /> <img src="https://github.com/user-attachments/assets/4f1dc8bb-8cf7-4ce3-8321-860060ab98f6" alt="Nav" width="30%" /> -->
4241

4342
## Terminal REPL
4443

45-
The Terminal replaces the old Console with a command-line interface for interacting with the ZeroClaw daemon. Type natural language to chat with your agent, or use slash commands to access every gateway operation directly.
44+
The Terminal replaces the old Console with a command-line interface for interacting with the PhoneClaw daemon. Type natural language to chat with your agent, or use slash commands to access every gateway operation directly.
4645

4746
### How it works
4847

@@ -61,7 +60,7 @@ Plain text (anything not starting with `/`) is routed as a chat message through
6160
| Command | Description |
6261
|---|---|
6362
| `/status` | Show daemon status |
64-
| `/version` | Show ZeroClaw version |
63+
| `/version` | Show PhoneClaw version |
6564
| `/health [component]` | Health summary or component detail |
6665
| `/doctor` | Run diagnostic checks |
6766
| `/cost` | Total cost summary |
@@ -206,7 +205,7 @@ Kotlin/Compose UI on top, Rust engine underneath, connected through Mozilla UniF
206205

207206
| Function | Description |
208207
| --------------------------------------------- | ----------------------------------------------- |
209-
| `start_daemon(config, dataDir, host, port)` | Start the ZeroClaw daemon with TOML config |
208+
| `start_daemon(config, dataDir, host, port)` | Start the PhoneClaw daemon with TOML config |
210209
| `stop_daemon()` | Signal shutdown and wait for all components |
211210
| `get_status()` | Returns JSON health snapshot |
212211
| `send_message(msg)` | Send a message to the gateway, returns response |
@@ -230,11 +229,11 @@ Plus 28 additional functions for cost tracking, cron scheduling, events, health
230229

231230
| Project | Description | Relationship |
232231
| -------------------------------------------------- | ---------------------------------- | -------------------------------------------------------------- |
233-
| [ZeroClaw](https://github.com/zeroclaw-labs/zeroclaw) | Rust-native AI agent framework | Upstream core (git submodule) |
234-
| OpenClaw | TypeScript-based AI agent platform | ZeroClaw is a Rust-native rewrite of the OpenClaw architecture |
235-
| ZeroClaw-Android | This project | Android wrapper with native FFI |
232+
| [PhoneClaw](https://github.com/PhoneClaw-labs/PhoneClaw) | Rust-native AI agent framework | Upstream core (git submodule) |
233+
| OpenClaw | TypeScript-based AI agent platform | PhoneClaw is a Rust-native rewrite of the OpenClaw architecture |
234+
| PhoneClaw-Android | This project | Android wrapper with native FFI |
236235

237-
ZeroClaw-Android wraps the upstream ZeroClaw engine without modification. Nader Dabit has called ZeroClaw "insanely fast" -- this project brings that speed to Android as an always-on service.
236+
PhoneClaw-Android wraps the upstream PhoneClaw engine without modification. Nader Dabit has called PhoneClaw "insanely fast" -- this project brings that speed to Android as an always-on service.
238237

239238
</details>
240239

@@ -258,8 +257,8 @@ ZeroClaw-Android wraps the upstream ZeroClaw engine without modification. Nader
258257
rustup target add aarch64-linux-android x86_64-linux-android
259258

260259
# Clone with submodules
261-
git clone --recursive https://github.com/Natfii/ZeroClaw-Android.git
262-
cd ZeroClaw-Android
260+
git clone --recursive https://github.com/0xboji/phoneclaw.git
261+
cd phoneclaw
263262

264263
# Set environment (adjust paths for your system)
265264
export JAVA_HOME="/path/to/jdk-17"
@@ -281,25 +280,13 @@ export ANDROID_HOME="/path/to/Android/Sdk"
281280

282281
The Gradle build invokes `cargo-ndk` via [Gobley](https://github.com/aspect-build/gobley) to cross-compile the Rust FFI library and generate UniFFI Kotlin bindings. No manual Rust build step needed.
283282

284-
### Project structure
285-
286-
```
287-
ZeroClaw-Android/
288-
app/ Android app (Kotlin/Compose)
289-
lib/ Library module (AAR publishing)
290-
zeroclaw/ Upstream ZeroClaw (git submodule)
291-
zeroclaw-android/ Cargo workspace
292-
zeroclaw-ffi/ UniFFI-annotated Rust facade
293-
.github/workflows/ CI, upstream sync, release
294-
```
295-
296283
</details>
297284

298285
<details>
299286
<summary>FAQ</summary>
300287

301288
**Does this run AI models on the phone itself?**
302-
Not directly. ZeroClaw-Android runs the agent *router* -- it manages which models to call, handles tool execution, and orchestrates multi-step workflows. Inference happens on the provider's servers (OpenAI, Claude, etc.) or on a local Ollama instance on your network.
289+
Not directly. PhoneClaw runs the agent *router* -- it manages which models to call, handles tool execution, and orchestrates multi-step workflows. Inference happens on the provider's servers (OpenAI, Claude, etc.) or on a local Ollama instance on your network.
303290

304291
**How much battery does it use?**
305292
The foreground service is idle most of the time, waking only when an agent needs to act. Typical usage is 2-5% battery per day. The app detects battery saver mode and reduces animations and non-essential work.
@@ -317,7 +304,7 @@ Yes, if you connect to a local Ollama instance or use the Synthetic provider for
317304
Not yet. Distribution is via GitHub Releases for now. Google Play is on the roadmap, along with expanded plugin support and Tasker/automation integration.
318305

319306
**Can I run multiple agents simultaneously?**
320-
Yes. ZeroClaw's router supports multiple agents with independent configurations, each connected to different providers if needed.
307+
Yes. PhoneClaw's router supports multiple agents with independent configurations, each connected to different providers if needed.
321308

322309
</details>
323310

@@ -329,5 +316,5 @@ This project is licensed under the MIT License. See [LICENSE](LICENSE) for detai
329316

330317
<!-- GitHub repo settings (not rendered):
331318
About/Description: Run AI agents 24/7 on your Android phone. Native Rust core, 32+ providers (OpenAI, Claude, Gemini, Groq, DeepSeek, Ollama, LM Studio, vLLM, Novita, Telnyx), encrypted key storage, plugin browser, Material You UI. Self-hosted alternative to Mac Mini setups. MIT licensed.
332-
Topics: ai-agent, android, rust, openai, anthropic, self-hosted, llm, foreground-service, kotlin, ai-agent-framework, material-you, ollama, groq, deepseek, gemini, iot, mqtt, encrypted-storage, jetpack-compose, zeroclaw
319+
Topics: ai-agent, android, rust, openai, anthropic, self-hosted, llm, foreground-service, kotlin, ai-agent-framework, material-you, ollama, groq, deepseek, gemini, iot, mqtt, encrypted-storage, jetpack-compose, PhoneClaw
333320
-->

0 commit comments

Comments
 (0)