@mudlab/create-workflow 1.0.0

package/README.md

@@ -0,0 +1,78 @@
+# @mudlab/create-workflow
+
+Scaffold a new [Mudlab](https://mudlab.io) workflow project in seconds.
+
+## Quick Start
+
+```bash
+# Using pnpm
+pnpm create @mudlab/workflow my-automations
+
+# Using npm
+npx @mudlab/create-workflow my-automations
+
+# Using yarn
+yarn create @mudlab/workflow my-automations
+```
+
+Then:
+
+```bash
+cd my-automations
+cp .env.example .env
+# Add your Mudlab API key to .env
+```
+
+## What You Get
+
+```
+my-automations/
+├── CLAUDE.md                    # AI orchestrator instructions (3-layer architecture)
+├── README.md                    # Project readme
+├── .env.example                 # Environment template
+├── .gitignore                   # Git ignore rules
+├── package.json                 # Project config
+├── directives/                  # Workflow documentation (SOPs)
+├── execution/
+│   ├── push_workflow.js         # Push workflows to Mudlab
+│   ├── tools/                   # Node.js tool functions
+│   ├── tools_directives/        # AI usage instructions for tools
+│   └── workflows/               # Workflow package definitions (JSON)
+├── assets/                      # Static assets
+└── .tmp/                        # Temp files (gitignored)
+```
+
+## Building Workflows
+
+1. **Create a tool** in `execution/tools/my_tool.js`:
+   ```javascript
+   async function run({ input, env, context }) {
+     const { name, API_KEY } = input;
+     // Your logic here
+     return {
+       action: "completed",
+       message: `Processed ${name}`
+     };
+   }
+   module.exports = { run };
+   ```
+
+2. **Create a workflow** in `execution/workflows/my_workflow.json`
+
+3. **Create a directive** in `directives/my_workflow.md`
+
+4. **Push to Mudlab**:
+   ```bash
+   node execution/push_workflow.js execution/workflows/my_workflow.json
+   ```
+
+See the generated `CLAUDE.md` for the complete 3-layer architecture documentation.
+
+## Learn More
+
+- [Mudlab Documentation](https://mudlab.io/docs)
+- [GitHub](https://github.com/mudlab/create-workflow)
+
+## License
+
+MIT

package/bin/create.js

@@ -0,0 +1,84 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+const projectName = process.argv[2];
+
+if (!projectName) {
+  console.error('Usage: pnpm create @mudlab/workflow <project-name>');
+  console.error('');
+  console.error('Example:');
+  console.error('  pnpm create @mudlab/workflow my-automations');
+  process.exit(1);
+}
+
+// Validate project name
+if (!/^[a-zA-Z0-9-_]+$/.test(projectName)) {
+  console.error('Error: Project name can only contain letters, numbers, hyphens, and underscores');
+  process.exit(1);
+}
+
+const targetDir = path.resolve(process.cwd(), projectName);
+
+// Check if directory already exists
+if (fs.existsSync(targetDir)) {
+  console.error(`Error: Directory "${projectName}" already exists`);
+  process.exit(1);
+}
+
+console.log(`\nCreating Mudlab workflow project in ${targetDir}...\n`);
+
+// Get template directory (relative to this script)
+const templateDir = path.join(__dirname, '..', 'template');
+
+// Copy template directory recursively
+function copyDir(src, dest) {
+  fs.mkdirSync(dest, { recursive: true });
+
+  const entries = fs.readdirSync(src, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+
+try {
+  // Copy template
+  copyDir(templateDir, targetDir);
+
+  // Update package.json with project name
+  const pkgPath = path.join(targetDir, 'package.json');
+  const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+  pkg.name = projectName;
+  fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
+
+  // Rename .env.example to .env (commented out - let user do it manually for safety)
+  // const envExample = path.join(targetDir, '.env.example');
+  // const envFile = path.join(targetDir, '.env');
+  // if (fs.existsSync(envExample)) {
+  //   fs.renameSync(envExample, envFile);
+  // }
+
+  console.log('Done! Next steps:\n');
+  console.log(`  cd ${projectName}`);
+  console.log('  cp .env.example .env');
+  console.log('  # Edit .env with your Mudlab API key\n');
+  console.log('Then start building workflows:');
+  console.log('  1. Add tools in execution/tools/');
+  console.log('  2. Add workflows in execution/workflows/');
+  console.log('  3. Add directives in directives/');
+  console.log('  4. Push: node execution/push_workflow.js execution/workflows/your_workflow.json\n');
+  console.log('See CLAUDE.md for the full 3-layer architecture guide.\n');
+
+} catch (error) {
+  console.error('Error creating project:', error.message);
+  process.exit(1);
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@mudlab/create-workflow",
+  "version": "1.0.0",
+  "description": "Create Mudlab workflow projects with a single command",
+  "bin": {
+    "create-mudlab-workflow": "./bin/create.js"
+  },
+  "files": [
+    "bin",
+    "template"
+  ],
+  "keywords": [
+    "mudlab",
+    "workflow",
+    "automation",
+    "ai",
+    "cli",
+    "scaffold",
+    "create"
+  ],
+  "author": "Mudlab <support@mudlab.io>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mudlab/create-workflow.git"
+  },
+  "homepage": "https://mudlab.io",
+  "engines": {
+    "node": ">=16"
+  }
+}

package/template/.env.example

@@ -0,0 +1,11 @@
+# Mudlab API Configuration
+MUDLAB_API_URL=http://localhost:3000
+MUDLAB_API_KEY=your_mudlab_api_key_here
+
+# Add your integration API keys below
+# These are passed to tools when running workflows locally
+# Example:
+# NOTION_API_KEY=your_notion_api_key
+# NOTION_DATABASE_ID=your_database_id
+# RESEND_API_KEY=your_resend_api_key
+# STRIPE_API_KEY=your_stripe_api_key