Skip to content

README.md

Latest commit

 

History

History
212 lines (151 loc) · 6.15 KB

README.md

File metadata and controls

212 lines (151 loc) · 6.15 KB

🦞 ClawdBot Control Panel

Your ClawdBot command center. Start, stop, manage skills, run commands — all from one sleek desktop UI.

ClawdBot Control Panel is a native desktop application for managing your ClawdBot AI gateway. Built with PyQt6, it works on Windows and macOS — giving you full control over your personal AI assistant without touching the terminal.

Website · Docs · Skills Hub · Discord

Python PyQt6 Platform License

📸 Preview

ClawdBot Control Panel

✨ Features

🎛️ Gateway Control

  • Start/Stop Service - One-click gateway management
  • Real-time Logs - Live streaming of gateway output
  • Status Monitoring - Visual indicators (Running/Stopped/Not Installed)
  • Open Gateway - Quick access to http://127.0.0.1:18789
  • Open Dashboard - Launch web UI with authentication token

📦 ClawdHub Skills Manager

  • Install Skills - Humanizer, self-improving-agent, and more
  • Skills Management - View and manage installed skills
  • Open Skills Folder - Direct access to skills directory
  • Update/Uninstall - Full lifecycle management

💻 Admin Terminal

  • Run Any Command - Execute with admin privileges
  • PowerShell Integration - UAC elevation on Windows
  • Real-time Output - Live command streaming
  • Copy/Clear Logs - Easy log management

⚙️ Settings & Maintenance

  • Version Info - Current and latest version display
  • Check Updates - One-click update checking
  • Reset/Uninstall - Maintenance operations

🎨 Modern UI

  • Dark Theme - Easy on the eyes
  • Sidebar Navigation - Dashboard, ClawdHub, Terminal, Settings
  • Quick Links - Skills Hub & Documentation
  • Responsive Design - Polished, professional look

📋 Requirements

  • Python 3.13 or higher
  • Windows 10/11 or macOS
  • ClawdBot installed (for full functionality)

🚀 Installation

Using UV (Recommended)

# Clone the repository
git clone https://github.com/SSujitX/clawdbot-ui.git
cd clawdbot-ui

# Install dependencies and run
uv sync
uv run main.py

Using pip

# Clone the repository
git clone https://github.com/SSujitX/clawdbot-ui.git
cd clawdbot-ui

# Create virtual environment
python -m venv .venv
.venv\Scripts\activate  # Windows
source .venv/bin/activate  # macOS/Linux

# Install dependencies
pip install -r requirements.txt

# Run the application
python main.py

🛠️ Building Locally

To build a standalone executable for Windows (with the application icon):

  1. Install Build Dependencies:

    uv add pyinstaller

  2. Run the Build Script:

    ./build_exe.ps1

    This will generate a single-file executable in the dist/ directory: dist/ClawdBot-Control-Panel.exe

📖 Usage

Starting the Gateway

  1. Launch the application
  2. Navigate to Dashboard
  3. Click Start Service
  4. View live logs in the terminal panel

Installing Skills

  1. Navigate to ClawdHub
  2. Enter skill name (e.g., humanizer)
  3. Click Install
  4. Monitor progress in the log panel

Running Admin Commands

  1. Navigate to Terminal
  2. Enter your command (e.g., clawdbot configure)
  3. Click Execute
  4. Approve UAC prompt if required (Windows)

🔗 Quick Links

🛠️ Tech Stack

Component Technology
UI Framework PyQt6
Package Manager UV
Language Python 3.13+
Styling Custom Dark Theme CSS
Process Management QThread + subprocess

📁 Project Structure

clawdbot-ui/
├── main.py                 # Entry point
├── pyproject.toml          # Project configuration
├── src/
│   ├── app.py              # Application setup
│   ├── ui/
│   │   ├── window.py       # Main window (4 pages)
│   │   ├── terminal.py     # Log viewer widget
│   │   ├── command_dialog.py # Modal command runner
│   │   └── styles.py       # Dark theme CSS
│   ├── core/
│   │   ├── process.py      # Background process runner
│   │   └── version.py      # Version checking
│   └── utils/
│       └── platform.py     # Platform detection + skills utilities
└── .agent/skills/          # Development skills

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • ClawdBot - The AI gateway this UI controls
  • PyQt6 - Python bindings for Qt
  • UV - Fast Python package manager

Made with ❤️ for developers who take control

Star History

Visitors

Made with ❤️ for the ClawdBot community