hyperclaw 5.2.1 → 5.2.3

package/README.md

@@ -1,3 +1,4 @@
+<a name="top"></a>
 <div align="center">
   <img src="assets/icon.png" width="140" alt="HyperClaw">
   <h1>🦅 HyperClaw</h1>
@@ -34,6 +35,28 @@
 
 ---
 
+## 📋 Table of Contents
+
+| | |
+|---|---|
+| [Why HyperClaw?](#why-hyperclaw) | [Use cases](#use-cases) |
+| [Screenshots](#screenshots) | [🚀 Get started in 60 seconds](#-get-started-in-60-seconds) |
+| [▶️ Running your bot](#️-running-your-bot) | [Channels](#channels) |
+| [Architecture](#architecture) | [AI Models](#ai-models) |
+| [Channels](#channels) | [Configuration](#configuration) |
+| [Security defaults](#security-defaults) | [Features](#features) |
+| [Apps (optional)](#apps-optional) | [Integrations (Skills & Tools)](#integrations-skills--tools) |
+| [Agent-to-Agent](#agent-to-agent-sessions-tools) | [Terminal chat](#terminal-chat-hyperclaw-chat) |
+| [Chat commands](#chat-commands) | [SkillHub](#skillhub) |
+| [HyperClaw Bot commands](#hyperclaw-bot-commands) | [From source](#from-source) |
+| [Docker](#docker) | [Monorepo structure](#monorepo-structure) |
+| [Documentation](#documentation) | [Contributing](#contributing) |
+| [Roadmap](#roadmap) | [Changelog](#changelog) |
+| [Community](#community) | [License](#license) |
+
+<div align="right"><a href="#top">▲ Back to top</a></div>
+---
+
 ## Why HyperClaw?
 
 | Feature | HyperClaw | Cloud assistants | Self-hosted alternatives |
@@ -51,6 +74,7 @@
 | One-command wizard (`hyperclaw onboard`) | ✅ | — | ❌ |
 | OSINT / Ethical hacking mode (`hyperclaw osint`) | ✅ | ❌ | ❌ |
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Use cases
@@ -66,6 +90,140 @@
 
 > HyperClaw runs **locally on your machine** — your data, your keys, your control.
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
+
+---
+
+## Screenshots
+
+### Main banner (`hyperclaw`)
+
+<div align="center">
+  <img src="assets/screenshot-banner.png" width="700" alt="HyperClaw main banner with quick actions">
+</div>
+
+---
+
+### Daemon mode (`hyperclaw daemon start`)
+
+<div align="center">
+  <img src="assets/screenshot-daemon-mode.png" width="700" alt="HyperClaw daemon mode — ALWAYS WATCHING">
+</div>
+
+> Red `🩸 DAEMON MODE - ALWAYS WATCHING 🩸` banner activates when running with full PC access.  
+> After starting, open `http://127.0.0.1:18789/chat` in your browser to chat with the agent.
+
+---
+
+### Setup wizard — start (`hyperclaw onboard`)
+
+<div align="center">
+  <img src="assets/screenshot-onboard-start.png" width="700" alt="HyperClaw onboard wizard start">
+</div>
+
+---
+
+### Setup wizard — AI providers
+
+<div align="center">
+  <img src="assets/screenshot-onboard-providers.png" width="700" alt="HyperClaw onboard AI provider selection">
+</div>
+
+---
+
+### Setup wizard — API key step
+
+<div align="center">
+  <img src="assets/screenshot-onboard-apikey.png" width="700" alt="HyperClaw onboard API key entry">
+</div>
+
+---
+
+### Daemon install mode (`hyperclaw onboard --install-daemon`)
+
+<div align="center">
+  <img src="assets/screenshot-onboard-daemon.png" width="700" alt="HyperClaw daemon install mode">
+</div>
+
+---
+
+### Security notice
+
+<div align="center">
+  <img src="assets/screenshot-security-notice.png" width="700" alt="HyperClaw security notice screen">
+</div>
+
+---
+
+### Theme selection
+
+<div align="center">
+  <img src="assets/screenshot-theme-select.png" width="700" alt="HyperClaw color theme selector">
+</div>
+
+---
+
+### Gateway Dashboard (`hyperclaw dashboard`)
+
+<div align="center">
+  <img src="assets/screenshot-dashboard.png" width="700" alt="HyperClaw Gateway Dashboard TUI">
+</div>
+
+> Live status, active channels, installed skills, and logs. Press `[d]` daemon · `[h]` hub · `[g]` gateway · `[m]` memory · `[q]` quit.
+
+---
+
+### Terminal chat (`hyperclaw chat`)
+
+<div align="center">
+  <img src="assets/screenshot-chat.png" width="700" alt="HyperClaw terminal chat interface">
+</div>
+
+---
+
+### All commands (`hyperclaw --help`)
+
+<div align="center">
+  <img src="assets/screenshot-help.png" width="700" alt="HyperClaw --help output showing all commands">
+</div>
+
+---
+
+### System status (`hyperclaw status`)
+
+<div align="center">
+  <img src="assets/screenshot-status.png" width="700" alt="HyperClaw status output">
+</div>
+
+---
+
+### Health check (`hyperclaw health`)
+
+<div align="center">
+  <img src="assets/screenshot-health.png" width="700" alt="HyperClaw health check output">
+</div>
+
+---
+
+### Security tools (`hyperclaw security`)
+
+<div align="center">
+  <img src="assets/screenshot-security.png" width="700" alt="HyperClaw security tools">
+</div>
+
+---
+
+### OSINT / Ethical Hacking mode (`hyperclaw osint`)
+
+<div align="center">
+  <img src="assets/screenshot-osint.png" width="700" alt="HyperClaw OSINT mode with recon, bugbounty, pentest workflows">
+</div>
+
+> Passive recon, bug bounty, pentest, digital footprint — all from your terminal.  
+> For authorized security research only.
+
+<div align="right"><a href="#top">▲ Back to top</a></div>
+
 ---
 
 ## 🚀 Get started in 60 seconds
@@ -305,6 +463,7 @@ brew install --cask iterm2
 
 </details>
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Channels
@@ -350,6 +509,7 @@ Add a channel:
 hyperclaw channels add telegram
 ```
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Architecture
@@ -374,6 +534,7 @@ Google Chat / Matrix / IRC / Mattermost / Teams / Nostr / WebChat
   OpenAI…)
 ```
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## AI Models
@@ -401,6 +562,7 @@ HyperClaw supports 20+ providers. Pick one in the wizard or set `provider.provid
 | **LM Studio** | `lmstudio` | Local models — enable local server |
 | **Custom** | `custom` | Any OpenAI-compatible `/chat/completions` |
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Configuration
@@ -475,6 +637,7 @@ Isolate DM sessions per channel/peer (useful when multiple people share one gate
 }
 ```
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Security defaults
@@ -499,6 +662,7 @@ hyperclaw security audit --json    # machine-readable output
 
 Full guide: [docs/security.md](docs/security.md)
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Features
@@ -520,6 +684,7 @@ Full guide: [docs/security.md](docs/security.md)
 - **Docker** — sandboxed agent execution, browser tools with Puppeteer
 - **Tailscale** — Serve/Funnel for remote access without port forwarding
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Apps (optional)
@@ -545,6 +710,7 @@ The Gateway alone delivers a great experience. Apps add extra features:
 - Camera, screen capture, device commands
 - Notifications, contacts, calendar, photos
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Development channels
@@ -563,6 +729,7 @@ hyperclaw update --channel dev      # moving head of main
 | `beta` | `beta` | Prerelease — new features, may have rough edges |
 | `dev` | `dev` | Latest main branch (when published) |
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Integrations (Skills & Tools)
@@ -678,6 +845,7 @@ OP_SERVICE_ACCOUNT_TOKEN=ops_xxxx
 
 All keys are stored locally in `~/.hyperclaw/.env` — never sent anywhere except the respective service.
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Agent-to-Agent (sessions tools)
@@ -695,6 +863,7 @@ Example — ask the agent:
 "List all connected sessions and send a briefing to the first one"
 ```
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Terminal chat (`hyperclaw chat`)
@@ -720,6 +889,7 @@ hyperclaw chat --model claude-opus-4-6  # override model
 
 Responses stream token-by-token as they are generated. The full conversation history is kept for the entire session (true multi-turn context).
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Chat commands
@@ -818,6 +988,7 @@ The agent can create fully custom skills on demand:
 
 Skills are saved to `~/.hyperclaw/workspace/skills/{id}/` and loaded on the next message.
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## HyperClaw Bot commands
@@ -857,6 +1028,7 @@ node dist/run-main.js onboard
 npm run gateway:watch
 ```
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Docker
@@ -889,6 +1061,7 @@ docker compose --profile full up -d
 
 See [`docker-compose.yml`](docker-compose.yml) and [`env.example`](env.example) for all options.
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Monorepo structure
@@ -927,6 +1100,7 @@ hyperclaw/
 └── docs/                   # Full documentation
 ```
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Documentation
@@ -978,6 +1152,49 @@ hyperclaw/
 | Troubleshooting | [docs/troubleshooting.md](docs/troubleshooting.md) |
 | Contributing | [docs/contributing.md](docs/contributing.md) |
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
+
+---
+
+## Roadmap
+
+> See [ROADMAP.md](ROADMAP.md) for the full plan.
+
+| Status | Feature |
+|--------|---------|
+| ✅ Done | 28+ messaging channels |
+| ✅ Done | Config hot-reload |
+| ✅ Done | MCP (Model Context Protocol) |
+| ✅ Done | OSINT / Ethical hacking mode |
+| ✅ Done | Docker sandboxing |
+| ✅ Done | TUI dashboard |
+| ✅ Done | macOS / iOS / Android companion apps |
+| 🔄 In progress | Web UI (browser-based dashboard) |
+| 🔄 In progress | Skill marketplace (HyperClaw Hub) |
+| 📅 Planned | Voice-first mode (always-on mic) |
+| 📅 Planned | Multi-agent collaboration |
+| 📅 Planned | Fine-tuned HyperClaw model |
+| 📅 Planned | One-click cloud deploy (Railway / Render) |
+
+<div align="right"><a href="#top">▲ Back to top</a></div>
+
+---
+
+## Changelog
+
+> Full history in [CHANGELOG.md](CHANGELOG.md).
+
+| Version | Highlights |
+|---------|-----------|
+| **v5.2.1** | Fix postinstall BOM, clean package-lock, nav links in all docs |
+| **v5.2.0** | MCP custom servers, OSINT mode, Tlon/Urbit integration |
+| **v5.1.0** | Config hot-reload, trustedProxies, session.dmScope, Google Chat guide |
+| **v5.0.7** | Groq model IDs fix, Cohere/HuggingFace baseUrl corrections |
+| **v5.0.0** | Major rewrite — monorepo, tsdown bundler, 20+ AI providers |
+| **v4.0.0** | Initial public release |
+
+<div align="right"><a href="#top">▲ Back to top</a></div>
+
 ---
 
 ## Contributing
@@ -987,6 +1204,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. AI/vibe-coded PRs welcome
 Found a bug? [Open an issue](https://github.com/mylo-2001/hyperclaw/issues/new/choose).  
 Found a vulnerability? Email [securityhyperclaw.ai@gmail.com](mailto:securityhyperclaw.ai@gmail.com) — we respond within 48 h.
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## Community
@@ -997,6 +1215,22 @@ Found a vulnerability? Email [securityhyperclaw.ai@gmail.com](mailto:securityhyp
 | 🐛 **Bug reports** | [GitHub Issues](https://github.com/mylo-2001/hyperclaw/issues) — templates for bugs & features |
 | 🔒 **Security** | [SECURITY.md](SECURITY.md) — responsible disclosure |
 
+### Contributors
+
+<a href="https://github.com/mylo-2001/hyperclaw/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=mylo-2001/hyperclaw" alt="Contributors" />
+</a>
+
+### Star History
+
+<a href="https://star-history.com/#mylo-2001/hyperclaw&Date">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=mylo-2001/hyperclaw&type=Date&theme=dark" />
+    <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=mylo-2001/hyperclaw&type=Date" />
+    <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=mylo-2001/hyperclaw&type=Date" />
+  </picture>
+</a>
+
 ---
 
 <div align="center">
@@ -1007,6 +1241,7 @@ Found a vulnerability? Email [securityhyperclaw.ai@gmail.com](mailto:securityhyp
 
 </div>
 
+<div align="right"><a href="#top">▲ Back to top</a></div>
 ---
 
 ## License