@mudlab/create-workflow 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -15,14 +15,20 @@ npx @mudlab/create-workflow my-automations
15
15
  yarn create @mudlab/workflow my-automations
16
16
  ```
17
17
 
18
- Then:
18
+ Then set up your API key:
19
19
 
20
20
  ```bash
21
21
  cd my-automations
22
22
  cp .env.example .env
23
- # Add your Mudlab API key to .env
24
23
  ```
25
24
 
25
+ Get your Mudlab API key:
26
+ 1. Log into your [Mudlab](https://mudlab.io) agency account
27
+ 2. Click **API Keys** in the left sidebar
28
+ 3. Click **Generate API Key**
29
+ 4. Name it `Push Mudlab Workflow Claude Code`
30
+ 5. Copy the key and add it to `.env`
31
+
26
32
  ## What You Get
27
33
 
28
34
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mudlab/create-workflow",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Create Mudlab workflow projects with a single command",
5
5
  "bin": {
6
6
  "create-mudlab-workflow": "./bin/create.js"
@@ -1,9 +1,24 @@
1
- # Mudlab API Configuration
2
- MUDLAB_API_URL=http://localhost:3000
1
+ # ===========================================
2
+ # MUDLAB API (Required for pushing workflows)
3
+ # ===========================================
4
+ # Get your API key:
5
+ # 1. Log into https://mudlab.io
6
+ # 2. Click "API Keys" in the left sidebar
7
+ # 3. Generate a key named "Push Mudlab Workflow Claude Code"
8
+ MUDLAB_API_URL=https://mudlab.io
3
9
  MUDLAB_API_KEY=your_mudlab_api_key_here
4
10
 
5
- # Add your integration API keys below
6
- # These are passed to tools when running workflows locally
11
+ # ===========================================
12
+ # INTEGRATION KEYS (For local testing only)
13
+ # ===========================================
14
+ # These keys are used when running tools locally with Node.js.
15
+ #
16
+ # FOR PRODUCTION: Add these in Mudlab UI instead:
17
+ # 1. Log into https://mudlab.io
18
+ # 2. Click "Environment Variables" in the left sidebar (below API Keys)
19
+ # 3. Add your variables there
20
+ #
21
+ # The variable NAMES you define here should match what you add in Mudlab.
7
22
  # Example:
8
23
  # NOTION_API_KEY=your_notion_api_key
9
24
  # NOTION_DATABASE_ID=your_database_id
@@ -4,12 +4,42 @@ Automated workflows powered by [Mudlab](https://mudlab.io).
4
4
 
5
5
  ## Setup
6
6
 
7
- 1. Copy `.env.example` to `.env` and add your API keys:
7
+ 1. Copy `.env.example` to `.env`:
8
8
  ```bash
9
9
  cp .env.example .env
10
10
  ```
11
11
 
12
- 2. Edit `.env` with your Mudlab API key and any integration keys you need.
12
+ 2. Get your Mudlab API key:
13
+ 1. Log into your [Mudlab](https://mudlab.io) agency account
14
+ 2. Click **API Keys** in the left sidebar
15
+ 3. Click **Generate API Key**
16
+ 4. Name it `Push Mudlab Workflow Claude Code`
17
+ 5. Copy the key
18
+
19
+ 3. Add the key to `.env`:
20
+ ```
21
+ MUDLAB_API_KEY=ml_your_key_here
22
+ ```
23
+
24
+ 4. (Optional) Add integration keys for **local testing**:
25
+ ```
26
+ NOTION_API_KEY=your_notion_api_key
27
+ RESEND_API_KEY=your_resend_api_key
28
+ ```
29
+
30
+ ## Environment Variables
31
+
32
+ Your workflows reference environment variable **names** (like `NOTION_API_KEY`). The actual values are stored in two places:
33
+
34
+ | Environment | Where to add keys | Used for |
35
+ |-------------|-------------------|----------|
36
+ | **Local** | `.env` file | Testing tools with `node` |
37
+ | **Production** | Mudlab UI | Running workflows via webhooks |
38
+
39
+ **To add production keys in Mudlab:**
40
+ 1. Log into [Mudlab](https://mudlab.io)
41
+ 2. Click **Environment Variables** in the left sidebar (below API Keys)
42
+ 3. Add your variables (use the same names as in your workflow definitions)
13
43
 
14
44
  ## Creating Workflows
15
45