clawflowbang 1.0.2 → 1.1.0

package/README.md

@@ -1,45 +1,52 @@
-# ClawFlow
+# 🦞 ClawFlow
 
-`ClawFlow` is a CLI wrapper for OpenClaw that installs skill bundles and wires cron jobs in one flow.
+**ClawFlow** is a skill + cron installer for OpenClaw/OpenKrab ecosystem.  
+It installs skill bundles and wires cron jobs in one flow, providing both CLI automation and package management.
 
-Published package: `clawflowbang`  
-Primary command: `clawflow` (alias: `cfh`)
+<p align="center">
+  <img src="/public/banner.png" alt="ClawFlow Banner" width="700">
+</p>
 
-## What It Does
+## Features
 
-- Install package presets (skills + cron jobs) with one command.
-- Install skills from ClawHub first, then fallback to Git clone if not found.
-- Manage cron jobs through `openclaw cron` (add/edit/remove/list).
-- Validate and normalize cron expressions before save.
+- **Package Management**: Install skill bundles with one command from ClawHub or Git
+- **Cron Automation**: Schedule and manage automated skill execution
+- **Fallback Installation**: ClawHub registry first, Git clone fallback
+- **Cron Validation**: Normalize and validate cron expressions
+- **CLI Interface**: Fast command-line tool (`clawflow` / `cfh`)
+- **NPM Integration**: Published as `clawflowbang` package
+- **Cross Platform**: Node.js based with Windows/Linux/macOS support
 
-## Requirements
+---
 
-- Node.js `>=16`
+## Quick Start
+
+### Prerequisites
+
+- Node.js 16+
 - OpenClaw CLI (`openclaw`)
-- ClawHub CLI (`clawhub`) for registry skill install
-- Git (used for fallback clone)
+- ClawHub CLI (`clawhub`) for registry access
+- Git (for fallback installation)
 
-## Install
+### Installation
 
 ```bash
 npm i -g clawflowbang
 ```
 
-Check:
+Verify installation:
 
 ```bash
 clawflow --version
 ```
 
-## Quick Start
-
-Initialize local config:
+### Initial Setup
 
 ```bash
 clawflow init
 ```
 
-Install a package preset:
+### Install Your First Package
 
 ```bash
 clawflow install trading-kit
@@ -51,29 +58,39 @@ Check status:
 clawflow status
 ```
 
-## Main Commands
+---
+
+## Core Commands
+
+### Package Management
+
+```bash
+clawflow install <package>              # Install skill bundle
+clawflow list [--available] [--npm]     # List installed/available packages
+clawflow search <query> [--no-npm]     # Search packages
+clawflow remove <package>               # Remove installed package
+```
+
+### Cron Operations
 
 ```bash
-clawflow install <package>
-clawflow list [--available] [--npm]
-clawflow search <query> [--no-npm]
-clawflow remove <package>
-
-clawflow cron-list
-clawflow cron-add <skill> --schedule "*/5 * * * *"
-clawflow cron-edit <id> --every 15m --description "updated job"
-clawflow cron-remove <id>
+clawflow cron-list                      # List all cron jobs
+clawflow cron-add <skill> --schedule "*/5 * * * *"  # Add new cron job
+clawflow cron-edit <id> --every 15m --description "updated job"  # Modify existing
+clawflow cron-remove <id>               # Remove cron job
 ```
 
+---
+
 ## Cron Input Formats
 
 Supported formats:
 
-- Raw cron: `*/5 * * * *`
-- Preset: `@hourly`, `@daily`, `@weekly`, `@monthly`
-- Shorthand: `5m`, `every 15m`, `1h`, `2d`
+- **Raw cron**: `*/5 * * * *`
+- **Preset**: `@hourly`, `@daily`, `@weekly`, `@monthly`
+- **Shorthand**: `5m`, `every 15m`, `1h`, `2d`
 
-Examples:
+### Examples
 
 ```bash
 clawflow cron-add crypto-price --every 15m
@@ -82,25 +99,35 @@ clawflow cron-edit <job-id> --params '{"symbols":["BTC","ETH"]}'
 clawflow cron-remove <job-id>
 ```
 
-## Skill Install Fallback (ClawHub -> Git)
+---
 
-When installing package skills:
+## Installation Flow
 
-1. Try `clawhub install`
-2. If failed, try `git clone` when skill metadata provides repository info
-3. Validate cloned skill by checking `SKILL.md`
+### Skill Installation Strategy
 
-Skill metadata fields for git fallback:
+1. **Primary**: Try `clawhub install` from registry
+2. **Fallback**: Use `git clone` when registry fails
+3. **Validation**: Check `SKILL.md` exists and is valid
 
-- `repository` or `repo` or `git`
-- optional `branch` / `tag` / `ref`
+### Git Fallback Metadata
 
-## Paths Used by Default
+Required fields in package metadata:
 
-- Skills path: `~/.openclaw/workspace/skills`
+- `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`
 
-Override during install:
+### Custom Paths
+
+Override defaults during installation:
 
 ```bash
 clawflow install <package> \
@@ -108,10 +135,11 @@ clawflow install <package> \
   --cron-jobs "<path-to-jobs.json>"
 ```
 
-## NPM Package Preset Format
+---
+
+## NPM Package Format
 
-`clawflow` can read package metadata from npm packages.  
-Use `clawflow` field in package.json:
+`clawflow` reads package metadata from npm packages using the `clawflow` field:
 
 ```json
 {
@@ -138,14 +166,99 @@ Use `clawflow` field in package.json:
 }
 ```
 
+---
+
+## 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
+
 ```bash
+git clone https://github.com/OpenKrab/ClawFlowHub.git
+cd ClawFlowHub
 npm install
-npm run lint
-npm test -- --runInBand
 ```
 
+### Development Commands
+
+```bash
+npm run lint                   # Lint code
+npm test                      # Run test suite
+npm start                     # Run CLI locally
+```
+
+### Testing
+
+```bash
+# 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 🦞*

package/bin/clawflowhub.js

@@ -1,117 +1,203 @@
-#!/usr/bin/env node
-
-require('dotenv').config();
-
-const { program } = require('commander');
-const pkg = require('../package.json');
+#!/usr/bin/env node
+
+require("dotenv").config();
+
+const { program } = require("commander");
+const pkg = require("../package.json");
+const chalk = require("chalk");
 
 // Import TUI
-const TUI = require('../src/core/TerminalUI');
+const TUI = require("../src/core/TerminalUI");
 
 // Import commands
-const installCommand = require('../src/commands/install');
-const listCommand = require('../src/commands/list');
-const removeCommand = require('../src/commands/remove');
-const cronCommand = require('../src/commands/cron');
-const statusCommand = require('../src/commands/status');
-const initCommand = require('../src/commands/init');
-const searchCommand = require('../src/commands/search');
+const installCommand = require("../src/commands/install");
+const listCommand = require("../src/commands/list");
+const removeCommand = require("../src/commands/remove");
+const cronCommand = require("../src/commands/cron");
+const statusCommand = require("../src/commands/status");
+const initCommand = require("../src/commands/init");
+const searchCommand = require("../src/commands/search");
+const createCommand = require("../src/commands/create");
+const doctorCommand = require("../src/commands/doctor");
+const registerCommand = require("../src/commands/register");
+const updateCommand = require("../src/commands/update");
+
+const exploreCommand = require("../src/commands/explore"); // Added exploreCommand
 
 // Print new TUI banner
 TUI.printBanner(pkg.version);
 
 program
-  .name('clawflow')
-  .description('Install OpenClaw skills and set up cronjobs')
-  .version(pkg.version, '-v, --version', 'Show version');
+  .name("clawflow")
+  .description("Install OpenClaw skills and set up cronjobs")
+  .version(pkg.version, "-v, --version", "Show version");
+
+// Create command
+program
+  .command("create [type] [name]")
+  .description("Create a new skill or agent template")
+  .action(createCommand);
 
 // Install command
+
 program
-  .command('install <package>')
-  .alias('i')
-  .description('Install a package including skills and cronjobs')
-  .option('-g, --global', 'Install globally')
-  .option('-c, --config <path>', 'Specify config file path')
-  .option('--skills-path <path>', 'Specify OpenClaw workspace skills path')
-  .option('--cron-jobs <path>', 'Specify OpenClaw cron jobs.json path')
-  .option('--openclaw-bin <path>', 'Path to openclaw CLI binary')
-  .option('--clawhub-bin <path>', 'Path to clawhub CLI binary')
-  .option('--no-cron', 'Install skills without creating cronjobs')
-  .option('--dry-run', 'Show what would be done without installing')
+  .command("install <package>")
+  .alias("i")
+  .description("Install a package including skills and cronjobs")
+  .option("-g, --global", "Install globally")
+  .option("-c, --config <path>", "Specify config file path")
+  .option("--skills-path <path>", "Specify OpenClaw workspace skills path")
+  .option("--cron-jobs <path>", "Specify OpenClaw cron jobs.json path")
+  .option("--openclaw-bin <path>", "Path to openclaw CLI binary")
+  .option("--clawhub-bin <path>", "Path to clawhub CLI binary")
+  .option("--no-cron", "Install skills without creating cronjobs")
+  .option("--dry-run", "Show what would be done without installing")
+  .option("--dev", "Local development mode (symlink skills)") // Added --dev option
+  .option("--bundle", "Install multiple skills if found in repository") // Added --bundle option
   .action(installCommand);
 
 // List command
 program
-  .command('list')
-  .alias('ls')
-  .description('Show installed packages and skills')
-  .option('-a, --available', 'Show packages available for install')
-  .option('-i, --installed', 'Show installed packages (default)')
-  .option('--npm', 'Include packages from npm registry (with --available)')
+  .command("list")
+  .alias("ls")
+  .description("Show installed packages and skills")
+  .option("-a, --available", "Show packages available for install")
+  .option("-i, --installed", "Show installed packages (default)")
+  .option("--npm", "Include packages from npm registry (with --available)")
   .action(listCommand);
 
 // Search command
 program
-  .command('search <query>')
-  .alias('find')
-  .description('Search packages in the registry')
-  .option('--no-npm', 'Exclude results from npm registry')
+  .command("search <query>")
+  .alias("find")
+  .description("Search packages in the registry")
+  .option("--no-npm", "Exclude results from npm registry")
   .action(searchCommand);
 
 // Remove command
 program
-  .command('remove <package>')
-  .alias('rm')
-  .description('Uninstall a package')
-  .option('-g, --global', 'Uninstall globally')
-  .option('--keep-config', 'Keep package config files')
+  .command("remove <package>")
+  .alias("rm")
+  .description("Uninstall a package")
+  .option("-g, --global", "Uninstall globally")
+  .option("--keep-config", "Keep package config files")
   .action(removeCommand);
 
 // Cron command group
 program
-  .command('cron-list')
-  .description('List all cronjobs')
+  .command("cron-list")
+  .description("List all cronjobs")
   .action(cronCommand.list);
 
 program
-  .command('cron-add <skill>')
-  .description('Add a cronjob for a skill')
-  .option('-s, --schedule <expression>', 'cron schedule expression', '*/5 * * * *')
-  .option('-e, --every <duration>', 'Shorthand like 5m, 1h, 2d')
-  .option('-d, --description <text>', 'Cronjob description')
-  .option('-p, --params <json>', 'Parameters for the skill')
+  .command("cron-add <skill>")
+  .description("Add a cronjob for a skill")
+  .option(
+    "-s, --schedule <expression>",
+    "cron schedule expression",
+    "*/5 * * * *",
+  )
+  .option("-e, --every <duration>", "Shorthand like 5m, 1h, 2d")
+  .option("-d, --description <text>", "Cronjob description")
+  .option("-p, --params <json>", "Parameters for the skill")
+  .option("--dry-run", "Show what would be done without adding")
   .action(cronCommand.add);
 
 program
-  .command('cron-edit <id>')
-  .description('Edit a cronjob')
-  .option('-s, --schedule <expression>', 'New cron schedule expression')
-  .option('-e, --every <duration>', 'Shorthand like 5m, 1h, 2d')
-  .option('-d, --description <text>', 'New description')
-  .option('-p, --params <json>', 'New parameters for the skill')
+  .command("cron-edit <id>")
+  .description("Edit a cronjob")
+  .option("-s, --schedule <expression>", "New cron schedule expression")
+  .option("-e, --every <duration>", "Shorthand like 5m, 1h, 2d")
+  .option("-d, --description <text>", "New description")
+  .option("-p, --params <json>", "New parameters for the skill")
   .action(cronCommand.edit);
 
 program
-  .command('cron-remove <id>')
-  .description('Remove a cronjob')
+  .command("cron-remove <id>")
+  .description("Remove a cronjob")
   .action(cronCommand.remove);
 
 // Status command
 program
-  .command('status')
-  .description('Show system status')
+  .command("status")
+  .description("Show system status")
   .action(statusCommand);
 
+// Register command
+program
+  .command("register [path]")
+  .description("Register a local skill or agent to OpenClaw")
+  .action(registerCommand);
+
+// Doctor command
+
+program
+  .command("doctor")
+  .description("Check system compatibility and configuration")
+  .action(doctorCommand);
+
+// Publish command (stub)
+program
+  .command("publish [path]")
+  .description("Publish a skill/agent to ClawHub")
+  .action(() => {
+    console.log(chalk.yellow("\n📦 clawflow publish is coming soon!"));
+    console.log(
+      chalk.gray(
+        "In the meantime, please use git to push to your repository.\n",
+      ),
+    );
+  });
+
+// Test command (stub)
+program
+  .command("test <skill>")
+  .description("Run tests or examples for a skill")
+  .action((skill) => {
+    console.log(chalk.cyan(`\n🧪 Testing skill: ${skill}...`));
+    console.log(chalk.yellow("Test runner integration is coming soon!\n"));
+  });
+
+// Integration commands
+program
+  .command("graph-add <skill>")
+  .description("Add a skill node to ClawGraph")
+  .action((skill) => {
+    console.log(chalk.cyan(`\n🕸️  Integrating ${skill} into ClawGraph...`));
+    console.log(chalk.yellow("ClawGraph integration is coming soon!\n"));
+  });
+
+program
+  .command("team-join <agent>")
+  .description("Register an agent to ClawTeam")
+  .action((agent) => {
+    console.log(chalk.cyan(`\n👥 Adding ${agent} to ClawTeam...`));
+    console.log(chalk.yellow("ClawTeam integration is coming soon!\n"));
+  });
+
+// Update command
+
+program
+  .command("update")
+  .description("Update ClawFlow CLI to the latest version")
+  .action(updateCommand);
+
+// Explore command
+program
+  .command("explore")
+  .description("Explore available skills and agents on ClawHub")
+  .action(exploreCommand);
+
 // Init command
 program
-  .command('init')
-  .description('Initialize ClawFlow in the current directory')
-  .option('-f, --force', 'Overwrite existing config')
+  .command("init")
+  .description("Initialize ClawFlow in the current directory")
+  .option("-f, --force", "Overwrite existing config")
   .action(initCommand);
 
 // Global error handler
-process.on('unhandledRejection', (err) => {
-  TUI.printError('เกิดข้อผิดพลาด: ' + err.message);
+process.on("unhandledRejection", (err) => {
+  TUI.printError("เกิดข้อผิดพลาด: " + err.message);
   if (process.env.DEBUG) {
     console.error(err.stack);
   }

package/package.json

@@ -1,12 +1,18 @@
 {
   "name": "clawflowbang",
-  "version": "1.0.2",
-  "description": "Skill + Cron Installer for OpenClaw - Install skills and configure them for immediate use",
+  "version": "1.1.0",
+  "description": "The ultimate CLI tool for Krab Ecosystem: Install skills, agents and automate cronjobs in one flow.",
   "main": "src/index.js",
-  "bin": {
-    "clawflow": "bin/clawflowhub.js",
-    "cfh": "bin/clawflowhub.js"
-  },
+  "bin": {
+    "clawflow": "bin/clawflowhub.js",
+    "cfh": "bin/clawflowhub.js"
+  },
+  "files": [
+    "src",
+    "bin",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
     "start": "node bin/clawflowhub.js",
     "test": "jest",
@@ -15,14 +21,20 @@
   "keywords": [
     "openclaw",
     "skill",
+    "agent",
     "cron",
     "installer",
     "automation",
     "clawhub",
-    "clawflow"
+    "clawflow",
+    "krab"
   ],
   "author": "ClawFlow Team",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OpenKrab/ClawFlow"
+  },
   "dependencies": {
     "axios": "^1.5.0",
     "boxen": "^8.0.1",
@@ -44,4 +56,4 @@
   "engines": {
     "node": ">=16.0.0"
   }
-}
+}