zeroclaw / README.md
personalbotai
Move picoclaw_space to root for Hugging Face Spaces deployment
c1dcaaa
---
title: zeroclaw
emoji: 🦞
colorFrom: blue
colorTo: indigo
sdk: docker
pinned: false
app_port: 7860
---
<div align="center">
<img src="assets/logo.jpg" alt="PicoClaw" width="512">
<h1>PicoClaw: Autonomous Distributed Systems Engineer</h1>
<h3>$10 Hardware · 10MB RAM · Voice-Enabled · Autonomous</h3>
<p>
<img src="https://img.shields.io/badge/Go-1.21+-00ADD8?style=flat&logo=go&logoColor=white" alt="Go">
<img src="https://img.shields.io/badge/Arch-x86__64%2C%20ARM64%2C%20RISC--V-blue" alt="Hardware">
<img src="https://img.shields.io/badge/license-MIT-green" alt="License">
<br>
<a href="https://picoclaw.io"><img src="https://img.shields.io/badge/Website-picoclaw.io-blue?style=flat&logo=google-chrome&logoColor=white" alt="Website"></a>
<a href="https://x.com/SipeedIO"><img src="https://img.shields.io/badge/X_(Twitter)-SipeedIO-black?style=flat&logo=x&logoColor=white" alt="Twitter"></a>
</p>
[中文](README.zh.md) | [日本語](README.ja.md) | **English**
</div>
---
🦐 **PicoClaw** is an ultra-lightweight, autonomous personal AI agent written in Go. Designed as a **Distributed Systems Engineer**, it combines the speed of Go with the intelligence of modern LLMs to handle complex tasks like Docker management, network debugging, and system monitoring with minimal resource footprint.
It runs on **$10 hardware** (like LicheeRV Nano) with **<10MB RAM**, making it 99% more efficient than Python-based alternatives.
<table align="center">
<tr align="center">
<td align="center" valign="top">
<p align="center">
<img src="assets/picoclaw_mem.gif" width="360" height="240">
</p>
</td>
<td align="center" valign="top">
<p align="center">
<img src="assets/licheervnano.png" width="400" height="240">
</p>
</td>
</tr>
</table>
> [!CAUTION]
> **🚨 SECURITY & OFFICIAL CHANNELS**
>
> * **NO CRYPTO:** PicoClaw has **NO** official token/coin. All claims on `pump.fun` or other trading platforms are **SCAMS**.
> * **OFFICIAL DOMAIN:** The **ONLY** official website is **[picoclaw.io](https://picoclaw.io)**.
> * **Warning:** PicoClaw is in Alpha. Do not deploy to critical production environments without review.
## 🚀 Capabilities
PicoClaw is more than just a chatbot. It's an autonomous engineer with specialized skills:
* **🗣️ Voice Interaction**: Speaks directly to you using Google TTS (Auto-configured).
* **🐳 Docker Management**: List, inspect, and manage containers via CLI.
* **🔬 AI Research**: Search ArXiv for papers and summarize findings.
* **🛠️ Go Development**: Assist with Go code, compilation, and debugging.
* **📊 Visualization**: Generate system architecture diagrams using Mermaid JS.
* **🌐 Network Utilities**: Debug DNS, ping hosts, and trace routes.
* **🛡️ Security Audit**: Scan code for secrets and vulnerabilities.
* **🧠 Memory & Planning**: Remembers context across sessions and plans complex tasks.
## 📦 Installation
```bash
curl -fsSL https://picoclaw.io/install.sh | sh
```
Or build from source:
```bash
git clone https://github.com/sipeed/picoclaw.git
cd picoclaw
make install
```
## 🛠️ Usage
### Quick Start
Start the interactive agent. It will automatically set up required skills (Voice, etc.) on first run.
```bash
picoclaw agent -m "Hello, who are you?"
```
### Voice Mode
PicoClaw can speak its responses! Ensure you have speakers connected.
```bash
# It will use the 'voice-tts' skill automatically when appropriate
picoclaw agent -m "Please introduce yourself in a voice message."
```
### Run as a Daemon (Gateway)
Run PicoClaw as a background service to handle heartbeats, cron jobs, and multi-channel messages (Telegram/Discord/etc).
```bash
picoclaw gateway
```
## 🐳 Docker Support
PicoClaw is available as a Docker image.
```bash
# Run agent
docker compose run --rm picoclaw-agent -m "Hello"
# Run gateway
docker compose up -d picoclaw-gateway
```
*Note: To use Voice or Docker skills within the container, you may need to mount `/dev/snd` or `/var/run/docker.sock`.*
## 🤝 Contributing
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
## 📄 License
MIT License