# hello-claw

**Repository Path**: ABCDRD/hello-claw

## Basic Information

- **Project Name**: hello-claw
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-17
- **Last Updated**: 2026-03-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

<img src="asset/logo.png" alt="Hello Claw Logo" width="400">

<p align="center"><em>In an unremarkable repository, a lobster was born.<br>Pick one and send it to school; or write your own undefined lobster.<br>Its dreams have been big from day one.</em></p>

# Hello Claw 👋

<p align="center"><em>Master OpenClaw from scratch: Adopt your AI lobster assistant or build your own agent</em></p>

<p align="center">
  📌 <a href="https://datawhalechina.github.io/hello-claw/">Read Online</a>
</p>

<p align="center">
    <a href="https://github.com/datawhalechina/hello-claw/stargazers" target="_blank">
        <img src="https://img.shields.io/github/stars/datawhalechina/hello-claw?color=660874&style=for-the-badge&logo=star&logoColor=white&labelColor=1a1a2e" alt="Stars"></a>
    <a href="https://github.com/datawhalechina/hello-claw/network/members" target="_blank">
        <img src="https://img.shields.io/github/forks/datawhalechina/hello-claw?color=660874&style=for-the-badge&logo=git-fork&logoColor=white&labelColor=1a1a2e" alt="Forks"></a>
    <a href="LICENSE" target="_blank">
        <img src="https://img.shields.io/badge/License-CC_BY_NC_SA_4.0-4ecdc4?style=for-the-badge&logo=creative-commons&logoColor=white&labelColor=1a1a2e" alt="License"></a>
</p>

<p align="center">
  <a href="README.md"><img alt="简体中文" src="https://img.shields.io/badge/简体中文-d9d9d9"></a>
  <a href="README_EN.md"><img alt="English" src="https://img.shields.io/badge/English-d9d9d9"></a>
</p>

</div>

> [!WARNING]
> 🧪 Beta Notice: Main content completed, details being refined. Issues and suggestions welcome!

## Read Online

https://datawhalechina.github.io/hello-claw

## Introduction

This is a comprehensive tutorial for OpenClaw, helping you master this powerful command-line AI assistant system from scratch. Whether you want to quickly adopt OpenClaw to boost productivity or dive deep into its principles to build your own version, this tutorial provides a clear learning path.

**Two Core Modules:**

1. **Adopt Claw (User Guide)**: Quick start with OpenClaw, learn to configure, use and extend this AI assistant
2. **Build Claw (Developer Guide)**: Deep dive into OpenClaw internals and master customization

**Who Should Learn:**

- Developers who want an always-ready AI command-line assistant
- Efficiency enthusiasts who want to control AI remotely via Telegram/Feishu
- Learners interested in OpenClaw's skill system and automation capabilities
- Tech enthusiasts who want to understand and build their own AI Agent tools

**Learning Path:**

- Beginners: Start with Part 1 "Adopt Claw" to gradually master usage
- Developers: Jump to Part 2 "Build Claw" to understand implementation principles

## 🔥 News

- **[2026-03-06]** ✅ Completed Ch.1-3: Installation, mobile access (Telegram/Feishu/QQ), automation basics
- **[2026-03-04]** 🦞 Project launched with two core modules: "Adopt Claw" and "Build Claw"

## 📖 Table of Contents

### Part 1: Adopt Claw

| Chapter | Description | Status |
| ---- | ---- | ---- |
| **Introduction** | **What is OpenClaw, why learn it, and how to use this tutorial** | ✅ |
| **Quick Start** | | |
| Ch.1 Quick Start OpenClaw | Node.js install, OpenClaw config, common commands, Coding Plan mode | ✅ |
| Ch.2 Mobile Access | Control via Telegram, Feishu and QQ anytime, anywhere | ✅ |
| Ch.3 Automation Basics | Scheduled reminders, automated reports, periodic workflows | ✅ |
| Ch.4 Skills System | Understand skills, install from marketplace, develop custom skills | 🚧 |
| **Advanced Practice** | | |
| Ch.5 External Integrations | Connect Gmail, Google Calendar, file systems & third-party services | 🚧 |
| Ch.6 Production Deployment | VPS selection, remote deployment, Docker isolation, 24/7 operation | 🚧 |
| Ch.7 Multi-Model & Cost Optimization | Multiple LLM config, local Ollama, API cost control | 🚧 |
| **Use Cases** | | |
| Ch.8 Personal Assistant System | Email management, scheduling, info organization, smart reminders | 🚧 |
| Ch.9 Content Creation Toolchain | Writing assistance, idea collection, asset management, auto-publishing | 🚧 |
| Ch.10 Developer Productivity | Code generation, Git automation, doc generation, testing assistance | 🚧 |
| Ch.11 Troubleshooting & Optimization | Common issues, performance tuning, community resources | 🚧 |
| **Appendix** | | |
| Appendix A: Command Reference | Complete CLI command reference | 🚧 |
| Appendix B: Configuration Guide | Configuration file parameters explained | 🚧 |
| Appendix C: Skill Templates | Sample code and best practices for skill development | 🚧 |
| Appendix D: Learning Resources | Official docs, community links, recommended learning paths | 🚧 |

---

### Part 2: Build Claw

| Chapter | Description | Status |
| ---- | ---- | ---- |
| **Introduction** | **Why build your Claw from scratch, OpenClaw complexity challenges, learning roadmap** | 🚧 |
| **Part 1: OpenClaw Internal Analysis** | | |
| Ch.1 Core Concepts & Design | Agent Runtime vs Chatbot, four primitive tools philosophy | 🚧 |
| Ch.2 Architecture Overview | Gateway, Bus, Agent, Provider modules, message flow | 🚧 |
| Ch.3 Prompt System | 7 Markdown files architecture, hot reload, Token optimization | 🚧 |
| Ch.4 Tool System | Four primitive tools, registration mechanism, Skill hierarchy | 🚧 |
| Ch.5 Message Loop & Events | ReAct loop, LLM tool selection, heartbeat mechanism | 🚧 |
| Ch.6 Multi-Channel Integration | Adapter design, Telegram/Discord/Feishu/DingTalk | 🚧 |
| **Part 2: Case Studies** | | |
| Ch.7 Lightweight Solutions | NanoClaw 500-line, Nanobot 4000-line, ZeroClaw | 🚧 |
| Ch.8 Security Hardening | IronClaw architecture, permissions, sandbox, audit logs | 🚧 |
| Ch.9 Hardware Solutions | PicoClaw hardware, Raspberry Pi, low-power optimization | 🚧 |
| Ch.10 Case Comparison | Comparison matrix, scenario guide, decision tree | 🚧 |
| **Part 3: Customize Your Claw** | | |
| Ch.11 Customization Roadmap | Four-level difficulty, scenarios, maintenance costs | 🚧 |
| Ch.12 Configuration Customization | config.json structure, tool whitelist, security | 🚧 |
| Ch.13 Skill Development | Skill structure, Frontmatter, async handlers, debugging | 🚧 |
| Ch.14 Channel Integration | DingTalk/Feishu workflow, adapter development | 🚧 |
| Ch.15 Complete Cases | Programming assistant, productivity bot, customer service | 🚧 |
| **Appendix** | | |
| Appendix A: OpenClaw Source Navigation | Core files reference, module locations, debugging tips | 🚧 |
| Appendix B: Reference Projects | Nanobot, NanoClaw, PicoClaw, IronClaw, ZeroClaw | 🚧 |
| Appendix C: Development Tools | Debugging, profiling, testing frameworks | 🚧 |

---

## 🦞 Use Case Gallery (Continuously Updated)

> Share your lobster use cases! If you have unique OpenClaw scenarios, welcome to submit a PR or Issue.

<table align="center">
  <tr>
    <td valign="top" width="33%">
      <b>🌅 Personal Productivity</b><br>
      • Morning briefing (weather + schedule + todos)<br>
      • Email auto-classification & summary<br>
      • Smart calendar management
    </td>
    <td valign="top" width="33%">
      <b>💻 Programming & Development</b><br>
      • Code generation & review<br>
      • Automated testing & deployment<br>
      • Documentation auto-generation
    </td>
    <td valign="top" width="33%">
      <b>📢 Content Creation</b><br>
      • Social media auto-management<br>
      • Writing assistance & polishing<br>
      • Multi-platform content publishing
    </td>
  </tr>
  <tr>
    <td valign="top" width="33%">
      <b>🏢 Business & Sales</b><br>
      • Customer support & CRM management<br>
      • Sales lead auto-follow-up<br>
      • Meeting scheduling & minutes
    </td>
    <td valign="top" width="33%">
      <b>🤖 Multi-Agent Collaboration</b><br>
      • Agent team project management<br>
      • Automated workflow orchestration<br>
      • Knowledge base sharing & retrieval
    </td>
    <td valign="top" width="33%">
      <b>🔧 More Scenarios</b><br>
      • Smart home control<br>
      • Financial data analysis<br>
      • Education & training assistance
    </td>
  </tr>
</table>

## 🙏 Contributors

| Name | Role | Bio |
| :----| :---- | :---- |
| [Sanbu](https://github.com/sanbuphy) | Project Lead | Datawhale Member |

*More contributors welcome*

## 🤝 Contributing

- If you find any issues, please submit an Issue. Contact the [support team](https://github.com/datawhalechina/DOPMC/blob/main/OP.md) if no response
- If you want to contribute, please submit a Pull Request. Contact the [support team](https://github.com/datawhalechina/DOPMC/blob/main/OP.md) if no response
- If you're interested in Datawhale and want to start a new project, follow the [Datawhale Open Source Guide](https://github.com/datawhalechina/DOPMC/blob/main/GUIDE.md)

## 📧 Follow Us

<div align=center>
<p>Scan QR code to follow our WeChat Official Account: Datawhale</p>
<img src="https://raw.githubusercontent.com/datawhalechina/pumpkin-book/master/res/qrcode.jpeg" width = "180" height = "180">
</div>

## 📄 LICENSE

<div align="center">
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">
  <img
    alt="Creative Commons License"
    style="border-width:0"
    src="https://img.shields.io/badge/license-CC%20BY--NC--SA%204.0-lightgrey"
  />
</a>
<br />
This work is licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">
  Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License
</a>.
</div>

---

<div align="center">
  <h3>⭐ If this project helps you, please give us a Star ❤️</h3>
</div>