openclaw/README.md

93 lines
2.4 KiB
Markdown
Raw Normal View History

<p align="center">
2026-03-04 19:46:13 -08:00
<a href="https://denchclaw.com">
<img src="assets/denchclaw-hero.png" alt="DenchClaw — AI CRM, hosted locally on your Mac. Built on OpenClaw." width="680" />
</a>
</p>
<p align="center">
2026-03-04 19:46:13 -08:00
<a href="https://www.npmjs.com/package/denchclaw"><img src="https://img.shields.io/npm/v/denchclaw?style=for-the-badge&color=000" alt="npm version"></a>&nbsp;
<a href="https://discord.gg/PDFXNVQj9n"><img src="https://img.shields.io/discord/1456350064065904867?label=Discord&logo=discord&logoColor=white&color=5865F2&style=for-the-badge" alt="Discord"></a>&nbsp;
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" alt="MIT License"></a>
</p>
<p align="center">
2026-03-04 19:46:13 -08:00
<a href="https://denchclaw.com">Website</a> · <a href="https://discord.gg/PDFXNVQj9n">Discord</a> · <a href="https://skills.sh">Skills Store</a>
</p>
2025-11-25 14:29:21 +01:00
2026-03-04 19:46:13 -08:00
<br />
<p align="center">
2026-03-04 19:46:13 -08:00
<a href="https://denchclaw.com">
<img src="assets/denchclaw-app.png" alt="DenchClaw Web UI — workspace, object tables, and AI chat" width="780" />
</a>
</p>
2026-03-04 19:46:13 -08:00
<br />
2026-01-31 23:41:43 -08:00
## Install
2026-01-01 21:09:24 +01:00
2026-03-04 19:46:13 -08:00
**Node 22+ required.**
```bash
2026-03-04 13:23:34 -08:00
npx denchclaw
```
2026-01-01 20:19:00 +01:00
2026-03-04 19:46:13 -08:00
Opens at `localhost:3100` after completing onboarding wizard.
---
2026-03-04 19:46:13 -08:00
## Commands
```bash
2026-03-04 19:46:13 -08:00
npx denchclaw # runs onboarding again for openclaw --profile dench
npx denchclaw update # updates denchclaw with current settings as is
npx denchclaw restart # restarts denchclaw web server
npx denchclaw start # starts denchclaw web server
npx denchclaw stop # stops denchclaw web server
# some examples
2026-03-04 19:46:13 -08:00
openclaw --profile dench <any openclaw command>
openclaw --profile dench gateway restart
openclaw --profile dench config set gateway.port 19001
openclaw --profile dench gateway install --force --port 19001
openclaw --profile dench gateway restart
```
---
2026-03-04 19:46:13 -08:00
## Development
```bash
2026-03-04 19:46:13 -08:00
git clone https://github.com/DenchHQ/DenchClaw.git
2026-03-04 13:23:34 -08:00
cd denchclaw
pnpm install
pnpm build
2026-03-04 19:46:13 -08:00
pnpm dev
```
Web UI development:
```bash
pnpm install
2026-03-04 19:46:13 -08:00
pnpm web:dev
```
---
## Open Source
MIT Licensed. Fork it, extend it, make it yours.
2025-12-09 20:28:10 +00:00
2026-03-04 19:46:13 -08:00
<p align="center">
<a href="https://star-history.com/?repos=DenchHQ%2FDenchClaw&type=date&legend=top-left">
<img src="https://api.star-history.com/image?repos=DenchHQ/DenchClaw&type=date&legend=top-left" alt="Star History" width="620" />
</a>
</p>
<p align="center">
2026-03-04 19:46:13 -08:00
<a href="https://github.com/DenchHQ/DenchClaw"><img src="https://img.shields.io/github/stars/DenchHQ/DenchClaw?style=for-the-badge" alt="GitHub stars"></a>
</p>