mlclaw-tui-demo / README.md
Princess3's picture
Upload folder using huggingface_hub
175214d verified
|
Raw
History Blame Contribute Delete
1.7 kB
---
title: ML Claw TUI Demo
emoji: 🐾
colorFrom: blue
colorTo: purple
sdk: static
app_file: app.py
pinned: false
license: mit
---
# ML Claw TUI Demo
A terminal user interface (TUI) for managing ML Claw deployments on Hugging Face Spaces.
## Features
- **Dashboard**: Overview of your ML Claw deployment
- **Bootstrap**: Create or update HF Space deployments
- **Gateway**: Start/stop/restart gateway operations
- **State**: Manage deployment state buckets
- **Models**: Configure inference models
- **Settings**: Update hardware and sleep settings
## Installation
```bash
# Install ML Claw with TUI support
npm install -g mlclaw
# Or clone and build from source
git clone https://github.com/huggingface/mlclaw.git
cd mlclaw
npm install
npm run build
```
## Usage
```bash
# Launch the TUI
mlclaw-tui
# Or use the CLI
mlclaw bootstrap
mlclaw gateway start my-agent
mlclaw gateway status my-agent
```
## Quick Start
1. Authenticate with Hugging Face:
```bash
hf auth login
```
2. Launch the TUI:
```bash
mlclaw-tui
```
3. Follow the interactive prompts to deploy your agent
## Keyboard Shortcuts
- `1-6`: Switch tabs
- `Alt+Left/Right`: Cycle tabs
- `Tab/Shift+Tab`: Navigate fields
- `Enter`: Confirm/Select
- `Ctrl+T`: Theme selector
- `Ctrl+D`: Toggle dark/light mode
- `q`: Quit
## Architecture
ML Claw deploys OpenClaw agents to Hugging Face Spaces with durable state in private Storage Buckets. The TUI provides a terminal-based interface for managing deployments.
## Links
- [ML Claw Repository](https://github.com/huggingface/mlclaw)
- [OpenClaw Documentation](https://github.com/huggingface/openclaw)
- [Hugging Face Spaces](https://huggingface.co/spaces)