Skip to content

OpenKrab/ClawFlow

🦞 ClawFlow

ClawFlow is the ultimate skill + agent + cron installer for the OpenClaw/OpenKrab ecosystem.
It provides a seamless developer experience to create, install, and automate AI skills in one unified flow.

ClawFlow Banner

✨ Features (v1.1.0+)

  • πŸ†• Dev-First Creation: Generate skill and agent templates in seconds with clawflow create
  • πŸš€ One-Step Installation: Install complex skill bundles from ClawHub or Git
  • πŸ› οΈ Local Development: Link your local work instantly with clawflow register or install --dev
  • ⏰ Smart Automation: Advanced cron management with shorthand support (e.g., 5m, 1h, 2d)
  • πŸ“¦ Bundle Support: Automatically detect and install multiple skills from a single repository
  • 🩺 System Diagnostic: Keep your environment healthy with clawflow doctor
  • πŸ” Discovery: Explore the ecosystem with clawflow search and explore

πŸš€ Quick Start

Prerequisites

  • Node.js 16+
  • OpenClaw CLI installed
  • Git (for fallback installation)

Installation

npm i -g clawflowbang

Verify installation:

clawflow --version

Initial Setup

clawflow init

πŸ› οΈ Developer Workflow

1. Create a new Skill or Agent

Generate a production-ready template in TypeScript or Python:

clawflow create skill my-cool-skill
# or
clawflow create agent my-research-agent

2. Local Development & Registration

Link your local skill folder directly to OpenClaw (Symlink mode):

cd my-cool-skill
clawflow register .

Changes you make in your local folder will reflect immediately in OpenClaw!

3. Install with Dev Mode

Install a remote package but setup symlinks for development:

clawflow install https://github.com/user/repo --dev

πŸ’» Core Commands

Package & Developer Management

clawflow create [type] [name]           # Create skill/agent template
clawflow register [path]                # Register local skill via symlink
clawflow install <package>              # Install from registry or URL
  --dev                                 # Symlink mode for local development
  --bundle                              # Install all sub-skills in repo
clawflow list [--available] [--npm]     # List installed/available packages
clawflow search <query>                 # Search packages
clawflow explore                        # Discover featured skills
clawflow doctor                         # Check system health

Cron Operations

clawflow cron-list                      # List all active cronjobs
clawflow cron-add <skill>               # Add new cronjob
  --schedule "*/5 * * * *"              # Standard cron
  --every 15m                           # Shorthand: 5m, 1h, 2d
  --dry-run                             # Preview before adding
clawflow cron-edit <id>                 # Modify existing job
clawflow cron-remove <id>               # Remove cronjob

⏰ Cron Input Formats

Supported formats:

  • Raw cron: */5 * * * *
  • Preset: @hourly, @daily, @weekly, @monthly
  • Shorthand: 5m, every 15m, 1h, 2d

Examples

clawflow cron-add crypto-price --every 15m
clawflow cron-edit <job-id> --schedule "@daily"
clawflow cron-edit <job-id> --params '{"symbols":["BTC","ETH"]}'
clawflow cron-remove <job-id>

Installation Flow

Skill Installation Strategy

  1. Primary: Try clawhub install from registry
  2. Fallback: Use git clone when registry fails
  3. Validation: Check SKILL.md exists and is valid

Git Fallback Metadata

Required fields in package metadata:

  • repository or repo or git - Git repository URL
  • Optional: branch / tag / ref - Specific version

Configuration

Default Paths

  • Skills directory: ~/.openclaw/workspace/skills
  • Cron jobs file: ~/.openclaw/cron/jobs.json

Custom Paths

Override defaults during installation:

clawflow install <package> \
  --skills-path "<path-to-skills>" \
  --cron-jobs "<path-to-jobs.json>"

NPM Package Format

clawflow reads package metadata from npm packages using the clawflow field:

{
  "name": "my-kit",
  "version": "1.0.0",
  "keywords": ["clawflow"],
  "clawflow": {
    "skills": [
      {
        "name": "crypto-price",
        "version": "^1.0.0",
        "source": "openclaw",
        "repository": "https://github.com/owner/crypto-price-skill.git"
      }
    ],
    "crons": [
      {
        "skill": "crypto-price",
        "schedule": "*/5 * * * *",
        "params": { "symbols": ["BTC", "ETH"] }
      }
    ]
  }
}

Tech Stack

  • Node.js 16+ - Core runtime
  • Commander.js - CLI framework
  • Node-cron - Cron job management
  • Axios - HTTP requests for registry
  • Chalk + Gradient-string - Terminal styling
  • Inquirer.js - Interactive prompts
  • YAML - Configuration parsing
  • Boxen - Beautiful terminal boxes

Project Structure

ClawFlowHub/
β”œβ”€β”€ bin/
β”‚   └── clawflowhub.js          # CLI entry point
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ index.js                # Main module
β”‚   β”œβ”€β”€ commands/               # Command implementations
β”‚   β”œβ”€β”€ utils/                 # Utility functions
β”‚   └── config/                # Configuration management
β”œβ”€β”€ skills/                    # Example skills
β”œβ”€β”€ examples/                  # Usage examples
β”œβ”€β”€ docs/                      # Documentation
β”œβ”€β”€ tests/                     # Test suite
β”œβ”€β”€ package.json               # NPM package config
β”œβ”€β”€ image.png                 # Project banner
└── README.md                 # This file

Development

Setup

git clone https://github.com/OpenKrab/ClawFlowHub.git
cd ClawFlowHub
npm install

Development Commands

npm run lint                   # Lint code
npm test                      # Run test suite
npm start                     # Run CLI locally

Testing

# Test basic functionality
clawflow --help
clawflow list --available
clawflow search crypto

OpenClaw Integration

ClawFlow integrates with OpenClaw ecosystem through:

  • Skill Installation: Direct integration with OpenClaw skill system
  • Cron Management: Uses OpenClaw's cron job infrastructure
  • Registry Access: Leverages ClawHub for skill discovery
  • Configuration: Respects OpenClaw's configuration patterns

Contributing

PRs are welcome! Please ensure:

  1. Code follows existing ESLint patterns
  2. Add tests for new functionality
  3. Update documentation as needed
  4. Test cross-platform compatibility
  5. Follow semantic versioning

License

MIT


Built for the Lobster Way 🦞

About

ClawFlow is a CLI wrapper for OpenClaw that installs skill bundles and wires cron jobs in one flow.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors