Add stagehand template (#3)

Author: juecd

.github/workflows/publish.yml

@@ -38,13 +38,36 @@ jobs:
       - name: Build
         run: bun run build
 
-      - name: Bump version and push
+      - name: Bump version and create PR
         run: |
           git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+          # Create a new branch for the version bump
+          BRANCH_NAME="chore/bump-version-$(date +%s)"
+          git checkout -b $BRANCH_NAME
+          # Bump version
           npm version patch -m "chore: bump version to %s [skip ci]"
-          git push origin HEAD:main --tags
+          # Push the new branch
+          git push origin $BRANCH_NAME
+          # Create PR using GitHub CLI
+          gh pr create \
+            --title "chore: bump version" \
+            --body "Automated version bump" \
+            --base main \
+            --head $BRANCH_NAME \
+            --label "automated" \
+            --label "version-bump"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_CLI_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Setup GitHub CLI
+        run: |
+          type -p curl >/dev/null || (sudo apt update && sudo apt install curl -y)
+          curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
+          && sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \
+          && echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
+          && sudo apt update \
+          && sudo apt install gh -y
       
       - name: Publish to NPM
         run: npm publish

README.md

@@ -11,8 +11,9 @@ A CLI tool to create the scaffolding for a  new Kernel applications. This tool h
 - 📦 Multiple template options:
   - Sample App: A basic template that extracts page titles using Playwright
   - Browser Use: A template implementing the Browser Use SDK
+  - Stagehand: A template implementing the Stagehand SDK
 - ⚡️ Automatic dependency setup
-- 🫶 Interactive CLI with helpful prompts
+- 🫶 Interactive CLI
 
 ## Set-Up
 
@@ -36,6 +37,7 @@ create-kernel-app [app-name] [options]
 - `-t, --template <template>`: Select a template
   - `sample-app`: Basic template with Playwright integration
   - `browser-use`: Template with Browser Use SDK (Python only)
+  - `stagehand`: Template with Stagehand SDK (Typescript only)
 
 ### Examples
 
@@ -44,6 +46,11 @@ Create a TypeScript application with a sample app:
 npx @onkernel/create-kernel-app my-app --language typescript --template sample-app
 ```
 
+Create a Typescript application with Stagehand template:
+```bash
+npx @onkernel/create-kernel-app my-app --language typescript --template stagehand
+```
+
 Create a Python application with a sample app:
 ```bash
 npx @onkernel/create-kernel-app my-app --language python --template sample-app
@@ -59,26 +66,54 @@ npx @onkernel/create-kernel-app my-app --language python --template browser-use
 After creating your application:
 
 1. Navigate to your project directory:
-   ```bash
-   cd my-app
-   ```
+```bash
+cd my-app
+```
 
 2. Set up your environment:
-   - For TypeScript: `npm install`
-   - For Python: `uv venv && source .venv/bin/activate && uv sync`
+- For TypeScript: `npm install`
+- For Python: `uv venv && source .venv/bin/activate && uv sync`
 
 3. Set your Kernel API key:
-   ```bash
-   export KERNEL_API_KEY=<YOUR_API_KEY>
-   ```
+```bash
+export KERNEL_API_KEY=<YOUR_API_KEY>
+```
 
 4. Deploy your application:
-   ```bash
-   kernel deploy index.ts  # for TypeScript
-   kernel deploy main.py   # for Python
-   ```
+```bash
+# Typscript
+kernel deploy index.ts  # --env OPENAI_API_KEY=XXX if Stagehand
+
+# Python
+kernel deploy main.py   # --env OPENAI_API_KEY=XXX if Browser Use
+```
+
+If deploying an app that requires environment variables, make sure to [set them](https://docs.onkernel.com/launch/deploy#environment-variables) when you `deploy`.
+
+5. Invoke your application:
+```bash
+# Typescript + Sample App
+kernel invoke ts-basic get-page-title --payload '{"url": "https://www.google.com"}'
+
+# Typescript + Stagehand
+kernel invoke ts-stagehand stagehand-task --payload '{"query": "Best wired earbuds"}'
+
+# Python + Sample App
+kernel invoke python-basic get-page-title --payload '{"url": "https://www.google.com"}'
+
+# Python + Browser Use
+kernel invoke python-bu bu-task --payload '{"task": "Compare the price of gpt-4o and DeepSeek-V3"}'
+```
+
+## Sample apps reference
+
+These are the sample apps currently available when you run `npx @onkernel/create-kernel-app`:
 
-5. Try out your application using the provided sample commands in the project README.
+| Template | Description | Framework | Query Parameters |
+|----------|-------------|-----------|------------------|
+| **sample-app** | Returns the page title of a specified URL | Playwright | `{ url }` |
+| **browser-use** | Completes a specified task | Browser Use | `{ task }` |
+| **stagehand** | Returns the first result of a specified Google search | Stagehand | `{ query }` |
 
 ## Documentation
 

bunfig.toml

@@ -2,10 +2,6 @@
 # Use exact versions for dependencies
 exact = true
 
-[test]
-# Enable TypeScript for tests
-preload = ["./test/setup.ts"]
-
 [debug]
 # Enable source maps for better debugging
 sourcemap = true

index.ts

@@ -13,7 +13,7 @@ const __dirname = path.dirname(__filename);
 
 // Types for better type safety
 type LanguageKey = 'typescript' | 'python';
-type TemplateKey = 'sample-app' | 'browser-use';
+type TemplateKey = 'sample-app' | 'browser-use' | 'stagehand';
 type LanguageInfo = { name: string; shorthand: string };
 type TemplateInfo = { name: string; description: string; languages: LanguageKey[] };
 
@@ -22,6 +22,7 @@ const LANGUAGE_TYPESCRIPT = 'typescript';
 const LANGUAGE_PYTHON = 'python';
 const TEMPLATE_SAMPLE_APP = 'sample-app';
 const TEMPLATE_BROWSER_USE = 'browser-use';
+const TEMPLATE_STAGEHAND = 'stagehand';
 const LANGUAGE_SHORTHAND_TS = 'ts';
 const LANGUAGE_SHORTHAND_PY = 'py';
 
@@ -41,13 +42,19 @@ const TEMPLATES: Record<TemplateKey, TemplateInfo> = {
     name: 'Browser Use',
     description: 'Implements Browser Use SDK',
     languages: [LANGUAGE_PYTHON]
-  }
+  },
+  [TEMPLATE_STAGEHAND]: { 
+    name: 'Stagehand', 
+    description: 'Implements the Stagehand SDK',
+    languages: [LANGUAGE_TYPESCRIPT]
+  },
 };
 
 const INVOKE_SAMPLES: Record<string, string> = {
   'typescript-sample-app': 'kernel invoke ts-basic get-page-title --payload \'{"url": "https://www.google.com"}\'',
   'python-sample-app': 'kernel invoke python-basic get-page-title --payload \'{"url": "https://www.google.com"}\'',
-  'python-browser-use': 'kernel invoke python-bu bu-task --payload \'{"task": "Compare the price of gpt-4o and DeepSeek-V3"}\''
+  'python-browser-use': 'kernel invoke python-bu bu-task --payload \'{"task": "Compare the price of gpt-4o and DeepSeek-V3"}\'',
+  'typescript-stagehand': 'kernel invoke ts-stagehand stagehand-task --payload \'{"query": "Best wired earbuds"}\''
 };
 
 const CONFIG = {
@@ -227,7 +234,8 @@ async function setupDependencies(appPath: string, language: LanguageKey): Promis
 // Print success message with next steps
 function printNextSteps(appName: string, language: LanguageKey, template: TemplateKey): void {
   // Determine which sample command to show based on language and template
-  const deployCommand = language === LANGUAGE_TYPESCRIPT ? 'kernel deploy index.ts'
+  const deployCommand = language === LANGUAGE_TYPESCRIPT && template === TEMPLATE_SAMPLE_APP ? 'kernel deploy index.ts'
+  : language === LANGUAGE_TYPESCRIPT && template === TEMPLATE_STAGEHAND ? 'kernel deploy index.ts --env OPENAI_API_KEY=XXX'
   : language === LANGUAGE_PYTHON && template === TEMPLATE_SAMPLE_APP ? 'kernel deploy main.py'
   : language === LANGUAGE_PYTHON && template === TEMPLATE_BROWSER_USE ? 'kernel deploy main.py --env OPENAI_API_KEY=XXX'
   : '';
@@ -254,7 +262,7 @@ program
   .version('0.1.0')
   .argument('[app-name]', 'Name of your Kernel app')
   .option('-l, --language <language>', `Programming language (${LANGUAGE_TYPESCRIPT}/${LANGUAGE_SHORTHAND_TS}, ${LANGUAGE_PYTHON}/${LANGUAGE_SHORTHAND_PY})`)
-  .option('-t, --template <template>', `Template type (${TEMPLATE_SAMPLE_APP}, ${TEMPLATE_BROWSER_USE})`)
+  .option('-t, --template <template>', `Template type (${TEMPLATE_SAMPLE_APP}, ${TEMPLATE_BROWSER_USE}, ${TEMPLATE_STAGEHAND})`)
   .action(async (appName: string, options: { language?: string; template?: string }) => {
     try {
       let normalizedLanguage: LanguageKey | null = null;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onkernel/create-kernel-app",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Create Kernel sample applications",
   "main": "dist/index.js",
   "type": "module",

templates/python/browser-use/main.py

@@ -3,7 +3,6 @@
 import kernel
 from kernel import Kernel
 from typing import TypedDict
-import os
 
 client = Kernel()
 

templates/python/browser-use/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "python-bu"
 version = "0.1.0"
-description = "Add your description here"
+description = "Kernel sample app for Browser Use"
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [