File: README.md Copy Chapter

ClawX

Overview Copy Chapter

ClawX bridges the gap between powerful AI agents and everyday users. Built on top of OpenClaw, it transforms command-line AI orchestration into an accessible, beautiful desktop experience - no terminal required.

Whether you're automating workflows, managing AI-powered channels, or scheduling intelligent tasks, ClawX provides the interface you need to harness AI agents effectively.

ClawX comes pre-configured with best-practice model providers and natively supports Windows as well as multi-language settings. You can also fine-tune advanced configurations via Settings -> Advanced -> Developer Mode.

Screenshots Copy Chapter

Why ClawX Copy Chapter

Building AI agents shouldn't require mastering the command line. ClawX was designed with a simple philosophy: powerful technology deserves an interface that respects your time. ClawX is built directly upon the official OpenClaw core. Instead of requiring a separate installation, we embed the runtime within the application for a seamless, battery-included experience. We stay closely aligned with upstream OpenClaw so you can benefit from the latest official capabilities, stability improvements, and ecosystem compatibility.

Features Copy Section

• 🎯 Zero Configuration Barrier: Complete setup through an intuitive graphical interface - no terminal commands, YAML files, or environment-variable hunting.
• 💬 Intelligent Chat Interface: Multi-session context and history, streaming Markdown with syntax highlighting, CJK-aware parsing, tables, KaTeX math, direct @agent routing, inline /skill cards, workspace-first sessions, and read-only previews for Markdown, .docx, .pptx, and local HTML.
• 📡 Multi-Channel Management: Configure and monitor independent AI channels with multiple accounts, per-account agent binding, default-account switching, and the bundled official Tencent personal WeChat channel plugin.
• ⏰ Cron-Based Automation: Define recurring or one-time schedules, insert skills into scheduled prompts, and deliver results to external channels.
• 🧩 Extensible Skill System: Manage skills locally without depending on the Gateway, discover skills from multiple OpenClaw sources, and use bundled document-processing skills for pdf, xlsx, docx, and pptx.
• 🔐 Secure Provider Integration: Connect OpenAI, Anthropic, Z.AI / GLM, and other providers with credentials stored in the native system keychain; supports OAuth, custom providers, image-generation endpoints, and compatibility fallbacks.
• 🌙 Adaptive Theming: Choose light mode, dark mode, or system-synchronized themes.
• 🚀 Startup Launch Control: Enable Launch at system startup in Settings -> General.
• 🔔 Update Prompts: Check for new versions at startup and choose whether to download or install them.

For full feature details, see docs/en-US/features.md.

Typical Use Cases Copy Section

• 🤖 Personal AI Assistant: Configure a general-purpose AI agent to answer questions, draft emails, summarize documents, and help with everyday tasks from a clean desktop interface.
• 📊 Automated Monitoring: Schedule agents to monitor news feeds, track prices, or watch for specific events, with results delivered to your preferred notification channel.
• 💻 Developer Productivity: Integrate AI into your development workflow for code review, documentation generation, and repetitive coding tasks.
• 🔄 Workflow Automation: Chain multiple skills into visual automation pipelines that process data, transform content, and trigger actions.

Getting Started Copy Chapter

System Requirements Copy Section

• Operating System: macOS 11+, Windows 10+, or Linux (Ubuntu 20.04+)
• Memory: 4GB RAM minimum (8GB recommended)
• Storage: 1GB available disk space

Installation Copy Section

Pre-built Releases (Recommended)

Download the latest release for your platform from the Releases page.

Build from Source

# Clone the repository
git clone https://github.com/ValueCell-ai/ClawX.git
cd ClawX

# Initialize the project
pnpm run init

# Start in development mode
pnpm dev

First Launch Copy Section

When you launch ClawX for the first time, the Setup Wizard will guide you through:

1. Language & Region - Configure your preferred locale
2. AI Provider - Add providers with API keys or OAuth for providers that support browser or device login
3. Skill Bundles - Select pre-configured skills for common use cases
4. Verification - Test your configuration before entering the main interface

The wizard preselects your system language when it is supported, and falls back to English otherwise.

Web search note: ClawX disables OpenClaw's general-purpose web_search tool at both the agent and Gateway policy layers. This includes Moonshot (Kimi) search; managed browser automation and web_fetch remain available.

Internal tool note: ClawX also disables gateway, nodes, create_goal, get_goal, and update_goal for agents at both policy layers. Application-owned Gateway RPCs remain available, as do messaging, session orchestration, and agent discovery tools.

Proxy Settings Copy Section

ClawX includes built-in proxy settings for Electron, the OpenClaw Gateway, and channels such as Telegram that need to reach the internet through a local proxy client.

Open Settings -> Gateway -> Proxy to configure the default proxy, bypass rules, and optional developer-mode overrides for HTTP, HTTPS, and ALL_PROXY / SOCKS. A local example is http://127.0.0.1:7890.

For proxy fallback behavior, Telegram synchronization, and OpenClaw Doctor, see docs/en-US/proxy-settings.md.

Architecture Copy Chapter

ClawX uses a dual-process architecture with a unified Host API layer: the React renderer calls one client abstraction, while Electron Main owns protocol selection, Gateway lifecycle, and the ACP Chat stdio bridge.

• Process model: Electron Main owns the window, Gateway supervision, system integration, and updates; the OpenClaw Gateway provides AI orchestration, channel, and skill capabilities; the renderer does not access local endpoints directly.
• Configuration delivery: Main uses config.get/config.set while the Gateway is running and updates the resolved JSON5 config while it is stopped or starting; ordinary provider, agent, skill, and model changes do not replace the process, credentials are hot-reloaded through secrets.reload, and guarded recovery starts after four consecutive heartbeat misses.
• ACP Chat: Chat UI talks to OpenClaw via ACP (Agent Client Protocol), providing a relatively stable chat protocol surface in front of the rapidly iterating OpenClaw. ACP runs through a Main-owned stdio bridge, supporting authenticated history replay after config reloads, streaming across navigation, and Main-validated media, attachments, and file activity. When a guarded Gateway restart interrupts an accepted turn, the patched OpenClaw runtime explicitly links its recovery run to the original ACP prompt so subsequent text and tool activity continue in the same in-memory turn; later history replay restores persisted tool boundaries as native ACP updates.
• Design principles: One frontend entry point, Main-owned transport, graceful recovery with reconnect/timeout/backoff, secure storage, and CORS-safe boundaries.

For the process diagram, configuration coordination, ACP file activity semantics, and Gateway troubleshooting, see docs/en-US/architecture.md.

Development Copy Chapter

Prerequisites Copy Section

• Node.js: 22.22.3+, 24.15.0+, or 25.9.0+ within the corresponding supported major line (Node 24 LTS recommended)
• Package Manager: pnpm 9+ (npm is also supported)
• Linux (Ubuntu/Debian): Install required system libraries before running Electron; see docs/en-US/development.md

Common Commands Copy Section

pnpm run init        # Install dependencies and download bundled runtimes
pnpm dev             # Start in development mode with hot reload
pnpm lint            # Run ESLint
pnpm typecheck       # TypeScript validation
pnpm test            # Run unit tests
pnpm run test:e2e    # Run Electron E2E smoke tests
pnpm build           # Full production build
pnpm package         # Package for the current platform (:mac / :win / :linux)

For the project structure, complete command list, E2E parallel policy, performance diagnostics, communication regression checks, and tech stack, see docs/en-US/development.md.

Contributing Copy Chapter

We welcome contributions from the community! Whether it's bug fixes, new features, documentation improvements, or translations, every contribution helps make ClawX better.

How to Contribute Copy Section

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes with clear messages
4. Push to your branch
5. Open a Pull Request

Guidelines Copy Section

• Follow the existing code style (ESLint + Prettier)
• Write tests for new functionality
• Update documentation as needed
• Keep commits atomic and descriptive

Acknowledgments Copy Chapter

ClawX is built on the shoulders of excellent open-source projects:

• OpenClaw - The AI agent runtime
• Electron - Cross-platform desktop framework
• React - UI component library
• shadcn/ui - Beautifully designed components
• Zustand - Lightweight state management

Community Copy Chapter

Join our community to connect with other users, get support, and share your experiences.

ClawX Partner Program Copy Section

We're launching the ClawX Partner Program and looking for partners who can help introduce ClawX to more clients, especially those with custom AI agent or automation needs.

Partners help connect us with potential users and projects, while the ClawX team provides full technical support, customization, and integration. If you work with clients interested in AI tools or automation, we'd love to collaborate.

DM us or email [email protected] to learn more.

Star History Copy Chapter

License Copy Chapter

ClawX is released under the MIT License. You're free to use, modify, and distribute this software.

File: resources/icons/README.md Copy Chapter

ClawX Application Icons

This directory contains the application icons for all supported platforms.

Required Files Copy Chapter

Generating Icons Copy Chapter

Using the Script Copy Section

# Make the script executable
chmod +x scripts/generate-icons.sh

# Run icon generation
./scripts/generate-icons.sh

Prerequisites Copy Section

macOS:

brew install imagemagick librsvg

Linux:

apt install imagemagick librsvg2-bin

Windows:
Install ImageMagick from https://imagemagick.org/

Manual Generation Copy Section

If you prefer to generate icons manually:

1. macOS (.icns)

   • Create a .iconset folder with properly named PNGs
   • Run: iconutil -c icns -o icon.icns ClawX.iconset

2. Windows (.ico)

   • Use ImageMagick: convert icon_16.png icon_32.png icon_64.png icon_128.png icon_256.png icon.ico

3. Linux (PNGs)

   • Generate PNGs at: 16, 32, 48, 64, 128, 256, 512 pixels

Design Guidelines Copy Chapter

Application Icon Copy Section

• Corner Radius: ~20% of width (200px on 1024px canvas)
• Foreground: White claw symbol with "X" accent
• Safe Area: Keep 10% margin from edges

macOS Tray Icon Copy Section

• Format: Single-color (black) on transparent background
• Size: 22x22 pixels (system automatically handles @2x retina)
• Naming: Must end with "Template.png" for automatic template mode
• Design: Simplified monochrome version of main icon (ClawX logo)
• Source: Use tray-icon-template.svg as the source
• Important: Must be pure black (#000000) on transparent background - no gradients or colors

Updating the Icon Copy Chapter

1. Edit icon.svg with your vector editor (Figma, Illustrator, Inkscape)
2. For macOS tray icon, edit tray-icon-template.svg (must be single-color black on transparent)
3. Run node scripts/generate-icons.mjs
4. Verify generated icons look correct
5. Commit all generated files