A lightweight personal AI assistant framework
Project description
Smart. Loyal. Powerful. ๐
ShibaClaw is a loyal, intelligent, and lightweight personal AI assistant framework โ built to serve and protect your digital workspace.
The only AI agent framework combining extreme multi-layer security (Structural Tool Output Wrapping against Prompt Injection + Smart Install Guard with live CVE scanning before every package install) with minimal token consumption, keeping your costs low without sacrificing power.
๐ข News
[!IMPORTANT] v0.0.8b is out! Update notifications, PyPI package, and Docker images on GHCR.
- 2026-04-03 ๐ Update Notifications โ A new Update tab in Settings shows the current vs latest version, and active channels (Telegram, Discord, ...) receive an automatic notification with ready-to-copy
pip/dockerupgrade commands. - 2026-04-03 ๐ฆ Available on PyPI & Docker โ Install in one line:
pip install shibaclaw. Docker images are published automatically on every release toghcr.io/rikyz90/shibaclaw. - 2026-04-01 ๐ Integrated File Browser โ A full file explorer in the WebUI sidebar: browse, view, edit and save workspace files directly from the browser. Path-traversal protected and workspace-sandboxed.
- 2026-04-01 ๐ File Attachments & Images โ Drag-and-drop or paste files and images directly into the chat. Images are previewed inline; other files are streamed to the agent as context.
- 2026-04-01 ๐งน Security Hardening & Cleanup โ Full production audit: 14 bugs fixed across asyncio locking, path traversal, CORS misconfiguration, unicode injection, pip-audit parsing, and TCP resource leaks.
- 2026-04-01 ๐ง Proactive Learning (Scent Mining) โ The agent periodically reflects on your conversation in the background, extracting key facts into long-term memory (
MEMORY.md) without any interruption. - 2026-03-31 ๐ Smart Install Guard โ Package installs (
pip,npm,apt, ...) are intercepted and audited for CVEs before execution. Critical/high severity packages are blocked with a full report; clean packages install freely. - 2026-03-29 ๐ก๏ธ Security & Core Modernization โ Enhanced Indirect Prompt Injection protection via Randomized Tool Output Wrapping: every tool response is enclosed in a dynamic per-session nonce boundary, so malicious instructions embedded in external data (web pages, files, API responses) cannot hijack the agent. LiteLLM fully removed in favor of native SDKs (
openai,anthropic) for leaner images and stricter control. GitHub Copilot OAuth rewritten with raw async device flow for stable background token refresh. Shell tool hardened against$(), backticks, piped shells (curl | bash), and process substitution. Gateway restart endpoint secured with token-based auth. - 2026-03-22 ๐งฉ Settings & WebUI Overhaul โ Tabbed settings modal, real-time Socket.IO streaming with process groups, Jupyter-style token auth, OAuth login directly from the browser, and interactive onboard wizard.
๐พ Key Features
- Fast & Faithful: Minimal startup time and dependencies.
- ๐ข Multi-channel: Support for Telegram, Discord, Slack, WhatsApp, and more.
- โฐ Always Alert: Built-in cron and heartbeat task scheduler.
- ๐งฉ Skills Registry: Modular and extensible skill system with native ClawHub marketplace support
- โก Parallel Multi-Agent Execution: A built-in fan-out orchestration model that spawns and coordinates specialized sub-agents concurrently for faster, scalable task resolution
- Advanced Thinking: Support for OpenAI, Azure, and deep-reasoning thinkers.
- ๐ก๏ธ Built-in Security: Protected against Indirect Prompt Injection via Structural Randomized Wrapping and strict per-session security policies.
- ๐ Smart Install Guard: Package installs are audited for CVEs before execution โ safe packages install freely, vulnerable ones are blocked with a full CVE report.
- ๐ง Proactive Learning (Scent Mining): Periodic background analysis of the active conversation to extract and persist key facts into long-term memory, ensuring no "scent" is lost even in long sessions.
- ๐ Integrated File Browser: Browse, view, edit and save workspace files directly from the WebUI โ no terminal needed.
- ๐ File Attachments & Images: Drag-and-drop or paste files and images directly into the chat for the agent to use as context.
- ๐ Auto Update Check: Periodic GitHub release monitoring every 12 hours โ notifies via WebUI and active channels with ready-to-copy upgrade commands.
๐ Loyal Only to You
Like the most devoted guard dog, ShibaClaw is trained to obey only its master. Thanks to its advanced Tool Output Wrapping system, the framework is hardened against Indirect Prompt Injection attacks. It treats external data from websites, files, or tools as literal informationโnever as new instructions. Your orders are final; to ShibaClaw, external noise is just a squirrel ๐ฟ๏ธ.
๐ Smart Install Guard
When the agent attempts to run a package installation command, ShibaClaw no longer blindly blocks it. Instead, it intercepts the command, audits the packages for known vulnerabilities (CVEs), and only proceeds if the risk is acceptable.
How It Works
- Detect โ The
ExecToolrecognizes install commands forpip,npm,yarn,pnpm,apt,dnf/yum, andbrew. - Audit โ Before execution, the packages are scanned:
- Python (
pip install ...) โpip-audit --format jsonchecks against the OSV/PyPA advisory database. - Node.js (
npm install ...) โnpm audit --jsonchecks against the npm security advisory database. - System packages (
apt/dnf) โ Safety flags (e.g.--allow-unauthenticated,--nogpgcheck) are checked; repository-level security is assumed. - Homebrew โ Allowed with medium confidence (curated formulae).
- Python (
- Decide โ Based on the configured severity threshold:
criticalorhighvulnerabilities โ install is blocked and the agent receives a full CVE report.mediumorlowvulnerabilities โ install proceeds with a warning appended to the output.- No vulnerabilities โ install proceeds cleanly.
- Fallback โ If audit tools are unavailable (no internet,
pip-auditnot installed), the install is allowed with a warning rather than blocked.
Destructive operations (
pip uninstall,npm remove,apt-get remove,apt-get purge) remain unconditionally blocked.
Configuration
In config.json under tools.exec:
{
"tools": {
"exec": {
"installAudit": true,
"installAuditTimeout": 120,
"installAuditBlockSeverity": "high"
}
}
}
| Option | Default | Description |
|---|---|---|
installAudit |
true |
Enable/disable vulnerability scanning for installs |
installAuditTimeout |
120 |
Seconds to wait for audit tools before falling back |
installAuditBlockSeverity |
"high" |
Minimum severity to block: critical, high, medium, low |
๐ง Proactive Learning (Scent Mining)
ShibaClaw won't wait for your session to end or the context window to fill to remember important details. With Proactive Learning, the agent periodically "sniffs" the recent conversation in the background to extract facts and project context.
How It Works
- Pulse โ Every 10 messages (default), a background task is triggered.
- Reflect โ A specialized mini-LLM call analyzes the recent history since the last pulse.
- Persist โ New facts, project status changes, or user preferences are extracted and merged into
MEMORY.md. - Zero Latency โ The learning process runs asynchronously via
_schedule_background. You can continue chatting without any interruption.
Configuration
In config.json under agents.defaults:
{
"agents": {
"defaults": {
"learning_enabled": true,
"learning_interval": 10
}
}
}
| Option | Default | Description |
|---|---|---|
learning_enabled |
true |
Enable periodic background fact extraction |
learning_interval |
10 |
Number of messages between learning pulses |
๐พ Quick Start
Ready to hunt? Choose your path:
๐ Docker (Recommended)
docker compose up -d --build # gateway + webUI
docker exec -it shibaclaw-gateway shibaclaw onboard --wizard # first-time setup
To update:
docker compose pull && docker compose up -d
Open http://localhost:3000 โ to get your access token, runshibaclaw print-tokenand paste it in the login screen or use the direct URL with the token appended.
๐ Bare Metal
pip install shibaclaw
shibaclaw onboard --wizard # first-time setup
shibaclaw web --port 3000 # start the WebUI (agent runs in-process)
Install from source:
pip install .(develop/edge builds)
See the full Easy Deploy Guide for detailed instructions and troubleshooting.
๐ฅ๏ธ WebUI
ย ย
Features at a Glance
- ๐ Token authentication โ auto-generated access token printed at startup (disable with
SHIBACLAW_AUTH=false) - Multi-session chat โ create, rename, archive, and switch between conversations
- Live process groups โ watch agent reasoning and tool calls stream in with elapsed time
- Settings modal โ configure model, provider, API keys, tools, gateway, channels, and OAuth providers
- OAuth login from UI โ authenticate GitHub Copilot and OpenAI Codex directly from the Settings panel
- Context viewer โ inspect workspace context and token usage
- Gateway monitor โ health check and one-click restart of the core AI engine
- Typing indicator โ animated feedback while the agent is working
- Responsive โ works on desktop and mobile
Architecture
| Layer | Stack |
|---|---|
| Server | Uvicorn โ Starlette (ASGI) + python-socketio |
| Real-time | Socket.IO 4.7.5 (WebSocket, polling fallback) |
| Frontend | Vanilla JS ยท Marked.js ยท Highlight.js (github-dark) |
| Container | Command | Port | Role |
|---|---|---|---|
shibaclaw-gateway |
shibaclaw gateway |
19999 | Core AI loop + message bus |
shibaclaw-web |
shibaclaw web --port 3000 |
3000 | WebUI (Starlette + Socket.IO) |
Both containers share the .shibaclaw/ volume for config, workspace, tools, and cache.
Resource Footprint
Approximate idle RAM usage in Docker:
| Component | RAM |
|---|---|
shibaclaw-gateway |
~115 MB |
shibaclaw-web |
~115 MB |
Values are indicative and can vary with model load, active sessions, and container runtime.
๐งฉ Supported Providers
ShibaClaw includes a unified provider registry and supports a wide range of LLM backends.
๐ API key-based providers
- OpenAI (
OPENAI_API_KEY) - Anthropic (
ANTHROPIC_API_KEY) - DeepSeek (
DEEPSEEK_API_KEY) - Gemini (
GEMINI_API_KEY) - Zhipu AI (
ZAI_API_KEY,ZHIPUAI_API_KEY) - DashScope (
DASHSCOPE_API_KEY) - Moonshot (
MOONSHOT_API_KEY,MOONSHOT_API_BASE) - MiniMax (
MINIMAX_API_KEY) - Groq (
GROQ_API_KEY)
๐ Gateway providers (auto-detected by key prefix / api_base)
- OpenRouter (
OPENROUTER_API_KEY, auto key prefixsk-or-, baseopenrouter) - AiHubMix (
OPENAI_API_KEY, baseaihubmix) - SiliconFlow (
OPENAI_API_KEY, basesiliconflow) - VolcEngine / BytePlus / Coding Plans (
OPENAI_API_KEY+ URL matching)
๐ Local providers
- vLLM / generic OpenAI-compatible local server (
HOSTED_VLLM_API_KEY,api_baseconfig) - Ollama (
OLLAMA_API_KEY,http://localhost:11434default)
๐ OAuth providers
- OpenAI Codex (OAuth,
openai-codex) - GitHub Copilot (OAuth,
github-copilot)
OAuth providers require a one-time login. Use the Settings โ OAuth Provider tab in the WebUI to check status and authenticate directly from the browser. The GitHub Copilot flow uses device codes; OpenAI Codex opens a browser-based PKCE flow.
CLI fallback:
shibaclaw provider login openai-codex # oauth-cli-kit device flow
shibaclaw provider login github-copilot # async device flow
Requirements: pip install oauth-cli-kit (Codex)
Useful commands
shibaclaw onboard --wizardshibaclaw status(check provider status and OAuth flags โ showsโ (OAuth)for authenticated OAuth providers)shibaclaw agent -m "Hello"
โ Check Status & Troubleshooting
shibaclaw statusreports workspace, config path, and provider status.docker logs shibaclaw-gateway/docker logs shibaclaw-webfor container logs.- Refer to
shibaclaw/thinkers/registry.pyfor provider list and prefixing behavior.
๐๏ธ Project Structure & Architecture
shibaclaw/- core implementationwebui/- web interface (server.py + static assets)agent/- AI agent loop and brainthinkers/- LLM provider registryupdater/- update checker, manifest downloader, and release watchercli/- CLI commands
bridge/- WhatsApp connectivity moduletests/- verification and testsassets/- project branding and visuals
Credits & Acknowledgements
This project was inspired by Nanobotโค๏ธ(https://github.com/HKUDS/nanobot) by HKUDS, released under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file shibaclaw-0.0.8b0.tar.gz.
File metadata
- Download URL: shibaclaw-0.0.8b0.tar.gz
- Upload date:
- Size: 917.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
13fb55150c6b92d1916e1760b8e30f93b6494d8d7edafc28c6dfdac588186834
|
|
| MD5 |
65810dd45ace0380d4d32b72a4d21112
|
|
| BLAKE2b-256 |
7fc46cd46a8cc0bf320ca395f7191b8898d200e90ebe4340cac1e3493237f507
|
Provenance
The following attestation bundles were made for shibaclaw-0.0.8b0.tar.gz:
Publisher:
publish.yml on RikyZ90/ShibaClaw
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
shibaclaw-0.0.8b0.tar.gz -
Subject digest:
13fb55150c6b92d1916e1760b8e30f93b6494d8d7edafc28c6dfdac588186834 - Sigstore transparency entry: 1224349938
- Sigstore integration time:
-
Permalink:
RikyZ90/ShibaClaw@ce7cf2401e12b33141f21ba239720ae2f0ba6f32 -
Branch / Tag:
refs/tags/v0.0.8b - Owner: https://github.com/RikyZ90
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ce7cf2401e12b33141f21ba239720ae2f0ba6f32 -
Trigger Event:
push
-
Statement type:
File details
Details for the file shibaclaw-0.0.8b0-py3-none-any.whl.
File metadata
- Download URL: shibaclaw-0.0.8b0-py3-none-any.whl
- Upload date:
- Size: 976.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ad27f993a317e203c744019447feef636a689c380216f1f055c604249721c918
|
|
| MD5 |
51486eb89c9b7ed6428e0f5649ef89d1
|
|
| BLAKE2b-256 |
e9cb3f570de3ba812026ee2566be416fa1b89e371391868a5c5bc0a099ca43fc
|
Provenance
The following attestation bundles were made for shibaclaw-0.0.8b0-py3-none-any.whl:
Publisher:
publish.yml on RikyZ90/ShibaClaw
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
shibaclaw-0.0.8b0-py3-none-any.whl -
Subject digest:
ad27f993a317e203c744019447feef636a689c380216f1f055c604249721c918 - Sigstore transparency entry: 1224349943
- Sigstore integration time:
-
Permalink:
RikyZ90/ShibaClaw@ce7cf2401e12b33141f21ba239720ae2f0ba6f32 -
Branch / Tag:
refs/tags/v0.0.8b - Owner: https://github.com/RikyZ90
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ce7cf2401e12b33141f21ba239720ae2f0ba6f32 -
Trigger Event:
push
-
Statement type: