Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
# Changelog

## [Unreleased] - 2026-02-06

### Added
- **Shared library architecture** (`sprite/lib/common.sh`)
- Centralized common functions across all spawn scripts
- Reduced code duplication by ~64%
- Easier maintenance and bug fixes

- **OAuth fallback mechanism**
- Automatic fallback to manual API key entry if OAuth fails
- Handles missing `nc` (netcat) gracefully
- Handles port conflicts and timeouts
- API key format validation with override option

- **Dual execution mode support**
- Scripts work locally: `bash sprite/openclaw.sh`
- Scripts work via curl: `curl URL | bash`
- Automatic detection and adaptation

- **Enhanced error handling**
- Graceful failure messages
- User-friendly prompts
- Non-fatal OAuth failures

### Changed
- **Refactored `openclaw.sh`**
- 258 lines β†’ 93 lines (-64%)
- Now uses shared library functions
- Cleaner, more focused logic

- **Refactored `claude.sh`**
- 272 lines β†’ 101 lines (-63%)
- Now uses shared library functions
- More maintainable code

- **OAuth flow improvements**
- Better error detection
- Server startup validation
- Process cleanup on failure

### Technical Details

**New Functions in `common.sh`:**
- `log_info()`, `log_warn()`, `log_error()` - Colored logging
- `ensure_sprite_installed()` - Install sprite CLI if needed
- `ensure_sprite_authenticated()` - Check/prompt for auth
- `get_sprite_name()` - User input for sprite name
- `ensure_sprite_exists()` - Create sprite if doesn't exist
- `verify_sprite_connectivity()` - Test sprite connection
- `run_sprite()` - Execute commands on sprite
- `setup_shell_environment()` - Configure PATH and zsh
- `try_oauth_flow()` - Attempt OAuth (can fail gracefully)
- `get_openrouter_api_key_manual()` - Manual API key entry
- `get_openrouter_api_key_oauth()` - OAuth with fallback
- `open_browser()` - Cross-platform browser launch

**Failure Scenarios Handled:**
1. Missing netcat (`nc`) command
2. Port already in use
3. OAuth server startup failure
4. OAuth timeout (2 minute default)
5. OAuth code exchange failure
6. No browser available
7. User cancellation

### Documentation
- `REFACTORING.md` - Detailed refactoring explanation
- `CURL_BASH_SOLUTION.md` - curl|bash compatibility details
- `OAUTH_FALLBACK.md` - OAuth fallback mechanism guide
- `CHANGELOG.md` - This file

### Backward Compatibility
- βœ… Scripts maintain identical functionality
- βœ… Same command-line interface
- βœ… Same environment setup
- βœ… Enhanced reliability through fallbacks

### Testing
All scripts validated with `bash -n` for syntax correctness.

**Test scenarios:**
```bash
# Local execution
bash sprite/claude.sh
bash sprite/openclaw.sh

# Remote execution (after pushing to GitHub)
curl https://raw.githubusercontent.com/.../sprite/claude.sh | bash

# Fallback testing
PATH=/tmp:$PATH bash sprite/claude.sh # Simulates missing nc
```

## Statistics

**Code Reduction:**
- openclaw.sh: 165 lines removed (-64%)
- claude.sh: 171 lines removed (-63%)
- Total duplicate code eliminated: ~330 lines
- New shared library: 203 lines
- Net reduction: ~130 lines

**Maintainability:**
- Common logic: 1 place to update (vs 2+)
- Function reuse: 12 shared functions
- Future scripts: ~90 lines instead of ~250 lines

## Migration Guide

No migration needed - scripts are backward compatible.

For developers adding new spawn scripts:
1. Source the common library
2. Use provided functions for setup
3. Add tool-specific configuration
4. Scripts automatically work with curl|bash

Example:
```bash
#!/bin/bash
set -e
source "$(dirname "${BASH_SOURCE[0]}")/lib/common.sh"

ensure_sprite_installed
ensure_sprite_authenticated
SPRITE_NAME=$(get_sprite_name)
ensure_sprite_exists "$SPRITE_NAME"
setup_shell_environment "$SPRITE_NAME"
API_KEY=$(get_openrouter_api_key_oauth)

# Tool-specific setup...
```
98 changes: 98 additions & 0 deletions CURL_BASH_SOLUTION.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
# curl | bash Compatibility

## The Problem

When running scripts via `curl URL | bash`:
```bash
curl https://example.com/script.sh | bash
```

**What happens:**
- Script is piped directly to bash (no file on disk)
- `${BASH_SOURCE[0]}` = `-` or `bash` (not a file path)
- Cannot use `source ./lib/common.sh` (no local files exist)

**Result:** Original refactoring would fail ❌

## The Solution

Scripts now detect their execution context and adapt:

```bash
if [[ -n "${BASH_SOURCE[0]}" && "${BASH_SOURCE[0]}" != "-" && "${BASH_SOURCE[0]}" != "bash" ]]; then
# Local: source from filesystem
source "$SCRIPT_DIR/lib/common.sh"
else
# Remote: download from GitHub
source <(curl -fsSL https://raw.githubusercontent.com/.../lib/common.sh)
fi
```

## Trade-offs

### βœ… Pros
- Works with both `curl | bash` and local execution
- Maintains code reusability (no duplication)
- Single source of truth for shared functions
- Easy to update (fix once, affects all scripts)

### ⚠️ Cons
- **Network dependency**: curl | bash requires downloading library
- **Single point of failure**: If GitHub is down, scripts fail
- **Cache opportunity**: Library is downloaded every time (not cached)
- **Trust model**: Users must trust both the script AND library URLs

## Alternative Approaches

### Option A: Inline Everything (Original Scripts)
```bash
# Pros: No external dependencies, works offline
# Cons: Code duplication, hard to maintain
```

### Option B: Bootstrap Script
```bash
# Download and cache locally first, then run
curl -fsSL https://url/install.sh | bash

# install.sh does:
mkdir -p /tmp/spawn
cd /tmp/spawn
curl -O lib/common.sh
curl -O openclaw.sh
bash openclaw.sh
```

### Option C: Self-Extracting Archive
```bash
# Embed library as base64 inside script
# Decode and source in memory
```

## Recommendation

**Current solution (hybrid source) is best because:**
1. Maintains developer experience (DRY code)
2. Works with existing `curl | bash` pattern
3. Minimal complexity
4. Standard approach in OSS (see: homebrew, rustup, etc.)

## Security Note

When using `curl | bash` from multiple URLs:
```bash
# User sees this
curl https://site.com/openclaw.sh | bash

# Script internally does this
source <(curl https://raw.githubusercontent.com/.../common.sh)
```

**Recommendation for users:**
```bash
# More secure: Review before running
curl -O https://site.com/openclaw.sh
curl -O https://raw.githubusercontent.com/.../common.sh
cat openclaw.sh common.sh # Review both files
bash openclaw.sh
```
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
# Changelog

## [Unreleased] - 2026-02-06

### Added
- **Shared library architecture** (`sprite/lib/common.sh`)
- Centralized common functions across all spawn scripts
- Reduced code duplication by ~64%
- Easier maintenance and bug fixes

- **OAuth fallback mechanism**
- Automatic fallback to manual API key entry if OAuth fails
- Handles missing `nc` (netcat) gracefully
- Handles port conflicts and timeouts
- API key format validation with override option

- **Dual execution mode support**
- Scripts work locally: `bash sprite/openclaw.sh`
- Scripts work via curl: `curl URL | bash`
- Automatic detection and adaptation

- **Enhanced error handling**
- Graceful failure messages
- User-friendly prompts
- Non-fatal OAuth failures

### Changed
- **Refactored `openclaw.sh`**
- 258 lines β†’ 93 lines (-64%)
- Now uses shared library functions
- Cleaner, more focused logic

- **Refactored `claude.sh`**
- 272 lines β†’ 101 lines (-63%)
- Now uses shared library functions
- More maintainable code

- **OAuth flow improvements**
- Better error detection
- Server startup validation
- Process cleanup on failure

### Technical Details

**New Functions in `common.sh`:**
- `log_info()`, `log_warn()`, `log_error()` - Colored logging
- `ensure_sprite_installed()` - Install sprite CLI if needed
- `ensure_sprite_authenticated()` - Check/prompt for auth
- `get_sprite_name()` - User input for sprite name
- `ensure_sprite_exists()` - Create sprite if doesn't exist
- `verify_sprite_connectivity()` - Test sprite connection
- `run_sprite()` - Execute commands on sprite
- `setup_shell_environment()` - Configure PATH and zsh
- `try_oauth_flow()` - Attempt OAuth (can fail gracefully)
- `get_openrouter_api_key_manual()` - Manual API key entry
- `get_openrouter_api_key_oauth()` - OAuth with fallback
- `open_browser()` - Cross-platform browser launch

**Failure Scenarios Handled:**
1. Missing netcat (`nc`) command
2. Port already in use
3. OAuth server startup failure
4. OAuth timeout (2 minute default)
5. OAuth code exchange failure
6. No browser available
7. User cancellation

### Documentation
- `REFACTORING.md` - Detailed refactoring explanation
- `CURL_BASH_SOLUTION.md` - curl|bash compatibility details
- `OAUTH_FALLBACK.md` - OAuth fallback mechanism guide
- `CHANGELOG.md` - This file

### Backward Compatibility
- βœ… Scripts maintain identical functionality
- βœ… Same command-line interface
- βœ… Same environment setup
- βœ… Enhanced reliability through fallbacks

### Testing
All scripts validated with `bash -n` for syntax correctness.

**Test scenarios:**
```bash
# Local execution
bash sprite/claude.sh
bash sprite/openclaw.sh

# Remote execution (after pushing to GitHub)
curl https://raw.githubusercontent.com/.../sprite/claude.sh | bash

# Fallback testing
PATH=/tmp:$PATH bash sprite/claude.sh # Simulates missing nc
```

## Statistics

**Code Reduction:**
- openclaw.sh: 165 lines removed (-64%)
- claude.sh: 171 lines removed (-63%)
- Total duplicate code eliminated: ~330 lines
- New shared library: 203 lines
- Net reduction: ~130 lines

**Maintainability:**
- Common logic: 1 place to update (vs 2+)
- Function reuse: 12 shared functions
- Future scripts: ~90 lines instead of ~250 lines

## Migration Guide

No migration needed - scripts are backward compatible.

For developers adding new spawn scripts:
1. Source the common library
2. Use provided functions for setup
3. Add tool-specific configuration
4. Scripts automatically work with curl|bash

Example:
```bash
#!/bin/bash
set -e
source "$(dirname "${BASH_SOURCE[0]}")/lib/common.sh"

ensure_sprite_installed
ensure_sprite_authenticated
SPRITE_NAME=$(get_sprite_name)
ensure_sprite_exists "$SPRITE_NAME"
setup_shell_environment "$SPRITE_NAME"
API_KEY=$(get_openrouter_api_key_oauth)

# Tool-specific setup...
```
98 changes: 98 additions & 0 deletions CURL_BASH_SOLUTION.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
# curl | bash Compatibility

## The Problem

When running scripts via `curl URL | bash`:
```bash
curl https://example.com/script.sh | bash
```

**What happens:**
- Script is piped directly to bash (no file on disk)
- `${BASH_SOURCE[0]}` = `-` or `bash` (not a file path)
- Cannot use `source ./lib/common.sh` (no local files exist)

**Result:** Original refactoring would fail ❌

## The Solution

Scripts now detect their execution context and adapt:

```bash
if [[ -n "${BASH_SOURCE[0]}" && "${BASH_SOURCE[0]}" != "-" && "${BASH_SOURCE[0]}" != "bash" ]]; then
# Local: source from filesystem
source "$SCRIPT_DIR/lib/common.sh"
else
# Remote: download from GitHub
source <(curl -fsSL https://raw.githubusercontent.com/.../lib/common.sh)
fi
```

## Trade-offs

### βœ… Pros
- Works with both `curl | bash` and local execution
- Maintains code reusability (no duplication)
- Single source of truth for shared functions
- Easy to update (fix once, affects all scripts)

### ⚠️ Cons
- **Network dependency**: curl | bash requires downloading library
- **Single point of failure**: If GitHub is down, scripts fail
- **Cache opportunity**: Library is downloaded every time (not cached)
- **Trust model**: Users must trust both the script AND library URLs

## Alternative Approaches

### Option A: Inline Everything (Original Scripts)
```bash
# Pros: No external dependencies, works offline
# Cons: Code duplication, hard to maintain
```

### Option B: Bootstrap Script
```bash
# Download and cache locally first, then run
curl -fsSL https://url/install.sh | bash

# install.sh does:
mkdir -p /tmp/spawn
cd /tmp/spawn
curl -O lib/common.sh
curl -O openclaw.sh
bash openclaw.sh
```

### Option C: Self-Extracting Archive
```bash
# Embed library as base64 inside script
# Decode and source in memory
```

## Recommendation

**Current solution (hybrid source) is best because:**
1. Maintains developer experience (DRY code)
2. Works with existing `curl | bash` pattern
3. Minimal complexity
4. Standard approach in OSS (see: homebrew, rustup, etc.)

## Security Note

When using `curl | bash` from multiple URLs:
```bash
# User sees this
curl https://site.com/openclaw.sh | bash

# Script internally does this
source <(curl https://raw.githubusercontent.com/.../common.sh)
```

**Recommendation for users:**
```bash
# More secure: Review before running
curl -O https://site.com/openclaw.sh
curl -O https://raw.githubusercontent.com/.../common.sh
cat openclaw.sh common.sh # Review both files
bash openclaw.sh
```
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
# Changelog

## [Unreleased] - 2026-02-06

### Added
- **Shared library architecture** (`sprite/lib/common.sh`)
- Centralized common functions across all spawn scripts
- Reduced code duplication by ~64%
- Easier maintenance and bug fixes

- **OAuth fallback mechanism**
- Automatic fallback to manual API key entry if OAuth fails
- Handles missing `nc` (netcat) gracefully
- Handles port conflicts and timeouts
- API key format validation with override option

- **Dual execution mode support**
- Scripts work locally: `bash sprite/openclaw.sh`
- Scripts work via curl: `curl URL | bash`
- Automatic detection and adaptation

- **Enhanced error handling**
- Graceful failure messages
- User-friendly prompts
- Non-fatal OAuth failures

### Changed
- **Refactored `openclaw.sh`**
- 258 lines β†’ 93 lines (-64%)
- Now uses shared library functions
- Cleaner, more focused logic

- **Refactored `claude.sh`**
- 272 lines β†’ 101 lines (-63%)
- Now uses shared library functions
- More maintainable code

- **OAuth flow improvements**
- Better error detection
- Server startup validation
- Process cleanup on failure

### Technical Details

**New Functions in `common.sh`:**
- `log_info()`, `log_warn()`, `log_error()` - Colored logging
- `ensure_sprite_installed()` - Install sprite CLI if needed
- `ensure_sprite_authenticated()` - Check/prompt for auth
- `get_sprite_name()` - User input for sprite name
- `ensure_sprite_exists()` - Create sprite if doesn't exist
- `verify_sprite_connectivity()` - Test sprite connection
- `run_sprite()` - Execute commands on sprite
- `setup_shell_environment()` - Configure PATH and zsh
- `try_oauth_flow()` - Attempt OAuth (can fail gracefully)
- `get_openrouter_api_key_manual()` - Manual API key entry
- `get_openrouter_api_key_oauth()` - OAuth with fallback
- `open_browser()` - Cross-platform browser launch

**Failure Scenarios Handled:**
1. Missing netcat (`nc`) command
2. Port already in use
3. OAuth server startup failure
4. OAuth timeout (2 minute default)
5. OAuth code exchange failure
6. No browser available
7. User cancellation

### Documentation
- `REFACTORING.md` - Detailed refactoring explanation
- `CURL_BASH_SOLUTION.md` - curl|bash compatibility details
- `OAUTH_FALLBACK.md` - OAuth fallback mechanism guide
- `CHANGELOG.md` - This file

### Backward Compatibility
- βœ… Scripts maintain identical functionality
- βœ… Same command-line interface
- βœ… Same environment setup
- βœ… Enhanced reliability through fallbacks

### Testing
All scripts validated with `bash -n` for syntax correctness.

**Test scenarios:**
```bash
# Local execution
bash sprite/claude.sh
bash sprite/openclaw.sh

# Remote execution (after pushing to GitHub)
curl https://raw.githubusercontent.com/.../sprite/claude.sh | bash

# Fallback testing
PATH=/tmp:$PATH bash sprite/claude.sh # Simulates missing nc
```

## Statistics

**Code Reduction:**
- openclaw.sh: 165 lines removed (-64%)
- claude.sh: 171 lines removed (-63%)
- Total duplicate code eliminated: ~330 lines
- New shared library: 203 lines
- Net reduction: ~130 lines

**Maintainability:**
- Common logic: 1 place to update (vs 2+)
- Function reuse: 12 shared functions
- Future scripts: ~90 lines instead of ~250 lines

## Migration Guide

No migration needed - scripts are backward compatible.

For developers adding new spawn scripts:
1. Source the common library
2. Use provided functions for setup
3. Add tool-specific configuration
4. Scripts automatically work with curl|bash

Example:
```bash
#!/bin/bash
set -e
source "$(dirname "${BASH_SOURCE[0]}")/lib/common.sh"

ensure_sprite_installed
ensure_sprite_authenticated
SPRITE_NAME=$(get_sprite_name)
ensure_sprite_exists "$SPRITE_NAME"
setup_shell_environment "$SPRITE_NAME"
API_KEY=$(get_openrouter_api_key_oauth)

# Tool-specific setup...
```
98 changes: 98 additions & 0 deletions CURL_BASH_SOLUTION.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
# curl | bash Compatibility

## The Problem

When running scripts via `curl URL | bash`:
```bash
curl https://example.com/script.sh | bash
```

**What happens:**
- Script is piped directly to bash (no file on disk)
- `${BASH_SOURCE[0]}` = `-` or `bash` (not a file path)
- Cannot use `source ./lib/common.sh` (no local files exist)

**Result:** Original refactoring would fail ❌

## The Solution

Scripts now detect their execution context and adapt:

```bash
if [[ -n "${BASH_SOURCE[0]}" && "${BASH_SOURCE[0]}" != "-" && "${BASH_SOURCE[0]}" != "bash" ]]; then
# Local: source from filesystem
source "$SCRIPT_DIR/lib/common.sh"
else
# Remote: download from GitHub
source <(curl -fsSL https://raw.githubusercontent.com/.../lib/common.sh)
fi
```

## Trade-offs

### βœ… Pros
- Works with both `curl | bash` and local execution
- Maintains code reusability (no duplication)
- Single source of truth for shared functions
- Easy to update (fix once, affects all scripts)

### ⚠️ Cons
- **Network dependency**: curl | bash requires downloading library
- **Single point of failure**: If GitHub is down, scripts fail
- **Cache opportunity**: Library is downloaded every time (not cached)
- **Trust model**: Users must trust both the script AND library URLs

## Alternative Approaches

### Option A: Inline Everything (Original Scripts)
```bash
# Pros: No external dependencies, works offline
# Cons: Code duplication, hard to maintain
```

### Option B: Bootstrap Script
```bash
# Download and cache locally first, then run
curl -fsSL https://url/install.sh | bash

# install.sh does:
mkdir -p /tmp/spawn
cd /tmp/spawn
curl -O lib/common.sh
curl -O openclaw.sh
bash openclaw.sh
```

### Option C: Self-Extracting Archive
```bash
# Embed library as base64 inside script
# Decode and source in memory
```

## Recommendation

**Current solution (hybrid source) is best because:**
1. Maintains developer experience (DRY code)
2. Works with existing `curl | bash` pattern
3. Minimal complexity
4. Standard approach in OSS (see: homebrew, rustup, etc.)

## Security Note

When using `curl | bash` from multiple URLs:
```bash
# User sees this
curl https://site.com/openclaw.sh | bash

# Script internally does this
source <(curl https://raw.githubusercontent.com/.../common.sh)
```

**Recommendation for users:**
```bash
# More secure: Review before running
curl -O https://site.com/openclaw.sh
curl -O https://raw.githubusercontent.com/.../common.sh
cat openclaw.sh common.sh # Review both files
bash openclaw.sh
```
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
# Changelog

## [Unreleased] - 2026-02-06

### Added
- **Shared library architecture** (`sprite/lib/common.sh`)
- Centralized common functions across all spawn scripts
- Reduced code duplication by ~64%
- Easier maintenance and bug fixes

- **OAuth fallback mechanism**
- Automatic fallback to manual API key entry if OAuth fails
- Handles missing `nc` (netcat) gracefully
- Handles port conflicts and timeouts
- API key format validation with override option

- **Dual execution mode support**
- Scripts work locally: `bash sprite/openclaw.sh`
- Scripts work via curl: `curl URL | bash`
- Automatic detection and adaptation

- **Enhanced error handling**
- Graceful failure messages
- User-friendly prompts
- Non-fatal OAuth failures

### Changed
- **Refactored `openclaw.sh`**
- 258 lines β†’ 93 lines (-64%)
- Now uses shared library functions
- Cleaner, more focused logic

- **Refactored `claude.sh`**
- 272 lines β†’ 101 lines (-63%)
- Now uses shared library functions
- More maintainable code

- **OAuth flow improvements**
- Better error detection
- Server startup validation
- Process cleanup on failure

### Technical Details

**New Functions in `common.sh`:**
- `log_info()`, `log_warn()`, `log_error()` - Colored logging
- `ensure_sprite_installed()` - Install sprite CLI if needed
- `ensure_sprite_authenticated()` - Check/prompt for auth
- `get_sprite_name()` - User input for sprite name
- `ensure_sprite_exists()` - Create sprite if doesn't exist
- `verify_sprite_connectivity()` - Test sprite connection
- `run_sprite()` - Execute commands on sprite
- `setup_shell_environment()` - Configure PATH and zsh
- `try_oauth_flow()` - Attempt OAuth (can fail gracefully)
- `get_openrouter_api_key_manual()` - Manual API key entry
- `get_openrouter_api_key_oauth()` - OAuth with fallback
- `open_browser()` - Cross-platform browser launch

**Failure Scenarios Handled:**
1. Missing netcat (`nc`) command
2. Port already in use
3. OAuth server startup failure
4. OAuth timeout (2 minute default)
5. OAuth code exchange failure
6. No browser available
7. User cancellation

### Documentation
- `REFACTORING.md` - Detailed refactoring explanation
- `CURL_BASH_SOLUTION.md` - curl|bash compatibility details
- `OAUTH_FALLBACK.md` - OAuth fallback mechanism guide
- `CHANGELOG.md` - This file

### Backward Compatibility
- βœ… Scripts maintain identical functionality
- βœ… Same command-line interface
- βœ… Same environment setup
- βœ… Enhanced reliability through fallbacks

### Testing
All scripts validated with `bash -n` for syntax correctness.

**Test scenarios:**
```bash
# Local execution
bash sprite/claude.sh
bash sprite/openclaw.sh

# Remote execution (after pushing to GitHub)
curl https://raw.githubusercontent.com/.../sprite/claude.sh | bash

# Fallback testing
PATH=/tmp:$PATH bash sprite/claude.sh # Simulates missing nc
```

## Statistics

**Code Reduction:**
- openclaw.sh: 165 lines removed (-64%)
- claude.sh: 171 lines removed (-63%)
- Total duplicate code eliminated: ~330 lines
- New shared library: 203 lines
- Net reduction: ~130 lines

**Maintainability:**
- Common logic: 1 place to update (vs 2+)
- Function reuse: 12 shared functions
- Future scripts: ~90 lines instead of ~250 lines

## Migration Guide

No migration needed - scripts are backward compatible.

For developers adding new spawn scripts:
1. Source the common library
2. Use provided functions for setup
3. Add tool-specific configuration
4. Scripts automatically work with curl|bash

Example:
```bash
#!/bin/bash
set -e
source "$(dirname "${BASH_SOURCE[0]}")/lib/common.sh"

ensure_sprite_installed
ensure_sprite_authenticated
SPRITE_NAME=$(get_sprite_name)
ensure_sprite_exists "$SPRITE_NAME"
setup_shell_environment "$SPRITE_NAME"
API_KEY=$(get_openrouter_api_key_oauth)

# Tool-specific setup...
```
98 changes: 98 additions & 0 deletions CURL_BASH_SOLUTION.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
# curl | bash Compatibility

## The Problem

When running scripts via `curl URL | bash`:
```bash
curl https://example.com/script.sh | bash
```

**What happens:**
- Script is piped directly to bash (no file on disk)
- `${BASH_SOURCE[0]}` = `-` or `bash` (not a file path)
- Cannot use `source ./lib/common.sh` (no local files exist)

**Result:** Original refactoring would fail ❌

## The Solution

Scripts now detect their execution context and adapt:

```bash
if [[ -n "${BASH_SOURCE[0]}" && "${BASH_SOURCE[0]}" != "-" && "${BASH_SOURCE[0]}" != "bash" ]]; then
# Local: source from filesystem
source "$SCRIPT_DIR/lib/common.sh"
else
# Remote: download from GitHub
source <(curl -fsSL https://raw.githubusercontent.com/.../lib/common.sh)
fi
```

## Trade-offs

### βœ… Pros
- Works with both `curl | bash` and local execution
- Maintains code reusability (no duplication)
- Single source of truth for shared functions
- Easy to update (fix once, affects all scripts)

### ⚠️ Cons
- **Network dependency**: curl | bash requires downloading library
- **Single point of failure**: If GitHub is down, scripts fail
- **Cache opportunity**: Library is downloaded every time (not cached)
- **Trust model**: Users must trust both the script AND library URLs

## Alternative Approaches

### Option A: Inline Everything (Original Scripts)
```bash
# Pros: No external dependencies, works offline
# Cons: Code duplication, hard to maintain
```

### Option B: Bootstrap Script
```bash
# Download and cache locally first, then run
curl -fsSL https://url/install.sh | bash

# install.sh does:
mkdir -p /tmp/spawn
cd /tmp/spawn
curl -O lib/common.sh
curl -O openclaw.sh
bash openclaw.sh
```

### Option C: Self-Extracting Archive
```bash
# Embed library as base64 inside script
# Decode and source in memory
```

## Recommendation

**Current solution (hybrid source) is best because:**
1. Maintains developer experience (DRY code)
2. Works with existing `curl | bash` pattern
3. Minimal complexity
4. Standard approach in OSS (see: homebrew, rustup, etc.)

## Security Note

When using `curl | bash` from multiple URLs:
```bash
# User sees this
curl https://site.com/openclaw.sh | bash

# Script internally does this
source <(curl https://raw.githubusercontent.com/.../common.sh)
```

**Recommendation for users:**
```bash
# More secure: Review before running
curl -O https://site.com/openclaw.sh
curl -O https://raw.githubusercontent.com/.../common.sh
cat openclaw.sh common.sh # Review both files
bash openclaw.sh
```
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
# Changelog

## [Unreleased] - 2026-02-06

### Added
- **Shared library architecture** (`sprite/lib/common.sh`)
- Centralized common functions across all spawn scripts
- Reduced code duplication by ~64%
- Easier maintenance and bug fixes

- **OAuth fallback mechanism**
- Automatic fallback to manual API key entry if OAuth fails
- Handles missing `nc` (netcat) gracefully
- Handles port conflicts and timeouts
- API key format validation with override option

- **Dual execution mode support**
- Scripts work locally: `bash sprite/openclaw.sh`
- Scripts work via curl: `curl URL | bash`
- Automatic detection and adaptation

- **Enhanced error handling**
- Graceful failure messages
- User-friendly prompts
- Non-fatal OAuth failures

### Changed
- **Refactored `openclaw.sh`**
- 258 lines β†’ 93 lines (-64%)
- Now uses shared library functions
- Cleaner, more focused logic

- **Refactored `claude.sh`**
- 272 lines β†’ 101 lines (-63%)
- Now uses shared library functions
- More maintainable code

- **OAuth flow improvements**
- Better error detection
- Server startup validation
- Process cleanup on failure

### Technical Details

**New Functions in `common.sh`:**
- `log_info()`, `log_warn()`, `log_error()` - Colored logging
- `ensure_sprite_installed()` - Install sprite CLI if needed
- `ensure_sprite_authenticated()` - Check/prompt for auth
- `get_sprite_name()` - User input for sprite name
- `ensure_sprite_exists()` - Create sprite if doesn't exist
- `verify_sprite_connectivity()` - Test sprite connection
- `run_sprite()` - Execute commands on sprite
- `setup_shell_environment()` - Configure PATH and zsh
- `try_oauth_flow()` - Attempt OAuth (can fail gracefully)
- `get_openrouter_api_key_manual()` - Manual API key entry
- `get_openrouter_api_key_oauth()` - OAuth with fallback
- `open_browser()` - Cross-platform browser launch

**Failure Scenarios Handled:**
1. Missing netcat (`nc`) command
2. Port already in use
3. OAuth server startup failure
4. OAuth timeout (2 minute default)
5. OAuth code exchange failure
6. No browser available
7. User cancellation

### Documentation
- `REFACTORING.md` - Detailed refactoring explanation
- `CURL_BASH_SOLUTION.md` - curl|bash compatibility details
- `OAUTH_FALLBACK.md` - OAuth fallback mechanism guide
- `CHANGELOG.md` - This file

### Backward Compatibility
- βœ… Scripts maintain identical functionality
- βœ… Same command-line interface
- βœ… Same environment setup
- βœ… Enhanced reliability through fallbacks

### Testing
All scripts validated with `bash -n` for syntax correctness.

**Test scenarios:**
```bash
# Local execution
bash sprite/claude.sh
bash sprite/openclaw.sh

# Remote execution (after pushing to GitHub)
curl https://raw.githubusercontent.com/.../sprite/claude.sh | bash

# Fallback testing
PATH=/tmp:$PATH bash sprite/claude.sh # Simulates missing nc
```

## Statistics

**Code Reduction:**
- openclaw.sh: 165 lines removed (-64%)
- claude.sh: 171 lines removed (-63%)
- Total duplicate code eliminated: ~330 lines
- New shared library: 203 lines
- Net reduction: ~130 lines

**Maintainability:**
- Common logic: 1 place to update (vs 2+)
- Function reuse: 12 shared functions
- Future scripts: ~90 lines instead of ~250 lines

## Migration Guide

No migration needed - scripts are backward compatible.

For developers adding new spawn scripts:
1. Source the common library
2. Use provided functions for setup
3. Add tool-specific configuration
4. Scripts automatically work with curl|bash

Example:
```bash
#!/bin/bash
set -e
source "$(dirname "${BASH_SOURCE[0]}")/lib/common.sh"

ensure_sprite_installed
ensure_sprite_authenticated
SPRITE_NAME=$(get_sprite_name)
ensure_sprite_exists "$SPRITE_NAME"
setup_shell_environment "$SPRITE_NAME"
API_KEY=$(get_openrouter_api_key_oauth)

# Tool-specific setup...
```
98 changes: 98 additions & 0 deletions CURL_BASH_SOLUTION.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
# curl | bash Compatibility

## The Problem

When running scripts via `curl URL | bash`:
```bash
curl https://example.com/script.sh | bash
```

**What happens:**
- Script is piped directly to bash (no file on disk)
- `${BASH_SOURCE[0]}` = `-` or `bash` (not a file path)
- Cannot use `source ./lib/common.sh` (no local files exist)

**Result:** Original refactoring would fail ❌

## The Solution

Scripts now detect their execution context and adapt:

```bash
if [[ -n "${BASH_SOURCE[0]}" && "${BASH_SOURCE[0]}" != "-" && "${BASH_SOURCE[0]}" != "bash" ]]; then
# Local: source from filesystem
source "$SCRIPT_DIR/lib/common.sh"
else
# Remote: download from GitHub
source <(curl -fsSL https://raw.githubusercontent.com/.../lib/common.sh)
fi
```

## Trade-offs

### βœ… Pros
- Works with both `curl | bash` and local execution
- Maintains code reusability (no duplication)
- Single source of truth for shared functions
- Easy to update (fix once, affects all scripts)

### ⚠️ Cons
- **Network dependency**: curl | bash requires downloading library
- **Single point of failure**: If GitHub is down, scripts fail
- **Cache opportunity**: Library is downloaded every time (not cached)
- **Trust model**: Users must trust both the script AND library URLs

## Alternative Approaches

### Option A: Inline Everything (Original Scripts)
```bash
# Pros: No external dependencies, works offline
# Cons: Code duplication, hard to maintain
```

### Option B: Bootstrap Script
```bash
# Download and cache locally first, then run
curl -fsSL https://url/install.sh | bash

# install.sh does:
mkdir -p /tmp/spawn
cd /tmp/spawn
curl -O lib/common.sh
curl -O openclaw.sh
bash openclaw.sh
```

### Option C: Self-Extracting Archive
```bash
# Embed library as base64 inside script
# Decode and source in memory
```

## Recommendation

**Current solution (hybrid source) is best because:**
1. Maintains developer experience (DRY code)
2. Works with existing `curl | bash` pattern
3. Minimal complexity
4. Standard approach in OSS (see: homebrew, rustup, etc.)

## Security Note

When using `curl | bash` from multiple URLs:
```bash
# User sees this
curl https://site.com/openclaw.sh | bash

# Script internally does this
source <(curl https://raw.githubusercontent.com/.../common.sh)
```

**Recommendation for users:**
```bash
# More secure: Review before running
curl -O https://site.com/openclaw.sh
curl -O https://raw.githubusercontent.com/.../common.sh
cat openclaw.sh common.sh # Review both files
bash openclaw.sh
```
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
# Changelog

## [Unreleased] - 2026-02-06

### Added
- **Shared library architecture** (`sprite/lib/common.sh`)
- Centralized common functions across all spawn scripts
- Reduced code duplication by ~64%
- Easier maintenance and bug fixes

- **OAuth fallback mechanism**
- Automatic fallback to manual API key entry if OAuth fails
- Handles missing `nc` (netcat) gracefully
- Handles port conflicts and timeouts
- API key format validation with override option

- **Dual execution mode support**
- Scripts work locally: `bash sprite/openclaw.sh`
- Scripts work via curl: `curl URL | bash`
- Automatic detection and adaptation

- **Enhanced error handling**
- Graceful failure messages
- User-friendly prompts
- Non-fatal OAuth failures

### Changed
- **Refactored `openclaw.sh`**
- 258 lines β†’ 93 lines (-64%)
- Now uses shared library functions
- Cleaner, more focused logic

- **Refactored `claude.sh`**
- 272 lines β†’ 101 lines (-63%)
- Now uses shared library functions
- More maintainable code

- **OAuth flow improvements**
- Better error detection
- Server startup validation
- Process cleanup on failure

### Technical Details

**New Functions in `common.sh`:**
- `log_info()`, `log_warn()`, `log_error()` - Colored logging
- `ensure_sprite_installed()` - Install sprite CLI if needed
- `ensure_sprite_authenticated()` - Check/prompt for auth
- `get_sprite_name()` - User input for sprite name
- `ensure_sprite_exists()` - Create sprite if doesn't exist
- `verify_sprite_connectivity()` - Test sprite connection
- `run_sprite()` - Execute commands on sprite
- `setup_shell_environment()` - Configure PATH and zsh
- `try_oauth_flow()` - Attempt OAuth (can fail gracefully)
- `get_openrouter_api_key_manual()` - Manual API key entry
- `get_openrouter_api_key_oauth()` - OAuth with fallback
- `open_browser()` - Cross-platform browser launch

**Failure Scenarios Handled:**
1. Missing netcat (`nc`) command
2. Port already in use
3. OAuth server startup failure
4. OAuth timeout (2 minute default)
5. OAuth code exchange failure
6. No browser available
7. User cancellation

### Documentation
- `REFACTORING.md` - Detailed refactoring explanation
- `CURL_BASH_SOLUTION.md` - curl|bash compatibility details
- `OAUTH_FALLBACK.md` - OAuth fallback mechanism guide
- `CHANGELOG.md` - This file

### Backward Compatibility
- βœ… Scripts maintain identical functionality
- βœ… Same command-line interface
- βœ… Same environment setup
- βœ… Enhanced reliability through fallbacks

### Testing
All scripts validated with `bash -n` for syntax correctness.

**Test scenarios:**
```bash
# Local execution
bash sprite/claude.sh
bash sprite/openclaw.sh

# Remote execution (after pushing to GitHub)
curl https://raw.githubusercontent.com/.../sprite/claude.sh | bash

# Fallback testing
PATH=/tmp:$PATH bash sprite/claude.sh # Simulates missing nc
```

## Statistics

**Code Reduction:**
- openclaw.sh: 165 lines removed (-64%)
- claude.sh: 171 lines removed (-63%)
- Total duplicate code eliminated: ~330 lines
- New shared library: 203 lines
- Net reduction: ~130 lines

**Maintainability:**
- Common logic: 1 place to update (vs 2+)
- Function reuse: 12 shared functions
- Future scripts: ~90 lines instead of ~250 lines

## Migration Guide

No migration needed - scripts are backward compatible.

For developers adding new spawn scripts:
1. Source the common library
2. Use provided functions for setup
3. Add tool-specific configuration
4. Scripts automatically work with curl|bash

Example:
```bash
#!/bin/bash
set -e
source "$(dirname "${BASH_SOURCE[0]}")/lib/common.sh"

ensure_sprite_installed
ensure_sprite_authenticated
SPRITE_NAME=$(get_sprite_name)
ensure_sprite_exists "$SPRITE_NAME"
setup_shell_environment "$SPRITE_NAME"
API_KEY=$(get_openrouter_api_key_oauth)

# Tool-specific setup...
```
98 changes: 98 additions & 0 deletions CURL_BASH_SOLUTION.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
# curl | bash Compatibility

## The Problem

When running scripts via `curl URL | bash`:
```bash
curl https://example.com/script.sh | bash
```

**What happens:**
- Script is piped directly to bash (no file on disk)
- `${BASH_SOURCE[0]}` = `-` or `bash` (not a file path)
- Cannot use `source ./lib/common.sh` (no local files exist)

**Result:** Original refactoring would fail ❌

## The Solution

Scripts now detect their execution context and adapt:

```bash
if [[ -n "${BASH_SOURCE[0]}" && "${BASH_SOURCE[0]}" != "-" && "${BASH_SOURCE[0]}" != "bash" ]]; then
# Local: source from filesystem
source "$SCRIPT_DIR/lib/common.sh"
else
# Remote: download from GitHub
source <(curl -fsSL https://raw.githubusercontent.com/.../lib/common.sh)
fi
```

## Trade-offs

### βœ… Pros
- Works with both `curl | bash` and local execution
- Maintains code reusability (no duplication)
- Single source of truth for shared functions
- Easy to update (fix once, affects all scripts)

### ⚠️ Cons
- **Network dependency**: curl | bash requires downloading library
- **Single point of failure**: If GitHub is down, scripts fail
- **Cache opportunity**: Library is downloaded every time (not cached)
- **Trust model**: Users must trust both the script AND library URLs

## Alternative Approaches

### Option A: Inline Everything (Original Scripts)
```bash
# Pros: No external dependencies, works offline
# Cons: Code duplication, hard to maintain
```

### Option B: Bootstrap Script
```bash
# Download and cache locally first, then run
curl -fsSL https://url/install.sh | bash

# install.sh does:
mkdir -p /tmp/spawn
cd /tmp/spawn
curl -O lib/common.sh
curl -O openclaw.sh
bash openclaw.sh
```

### Option C: Self-Extracting Archive
```bash
# Embed library as base64 inside script
# Decode and source in memory
```

## Recommendation

**Current solution (hybrid source) is best because:**
1. Maintains developer experience (DRY code)
2. Works with existing `curl | bash` pattern
3. Minimal complexity
4. Standard approach in OSS (see: homebrew, rustup, etc.)

## Security Note

When using `curl | bash` from multiple URLs:
```bash
# User sees this
curl https://site.com/openclaw.sh | bash

# Script internally does this
source <(curl https://raw.githubusercontent.com/.../common.sh)
```

**Recommendation for users:**
```bash
# More secure: Review before running
curl -O https://site.com/openclaw.sh
curl -O https://raw.githubusercontent.com/.../common.sh
cat openclaw.sh common.sh # Review both files
bash openclaw.sh
```
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
# Changelog

## [Unreleased] - 2026-02-06

### Added
- **Shared library architecture** (`sprite/lib/common.sh`)
- Centralized common functions across all spawn scripts
- Reduced code duplication by ~64%
- Easier maintenance and bug fixes

- **OAuth fallback mechanism**
- Automatic fallback to manual API key entry if OAuth fails
- Handles missing `nc` (netcat) gracefully
- Handles port conflicts and timeouts
- API key format validation with override option

- **Dual execution mode support**
- Scripts work locally: `bash sprite/openclaw.sh`
- Scripts work via curl: `curl URL | bash`
- Automatic detection and adaptation

- **Enhanced error handling**
- Graceful failure messages
- User-friendly prompts
- Non-fatal OAuth failures

### Changed
- **Refactored `openclaw.sh`**
- 258 lines β†’ 93 lines (-64%)
- Now uses shared library functions
- Cleaner, more focused logic

- **Refactored `claude.sh`**
- 272 lines β†’ 101 lines (-63%)
- Now uses shared library functions
- More maintainable code

- **OAuth flow improvements**
- Better error detection
- Server startup validation
- Process cleanup on failure

### Technical Details

**New Functions in `common.sh`:**
- `log_info()`, `log_warn()`, `log_error()` - Colored logging
- `ensure_sprite_installed()` - Install sprite CLI if needed
- `ensure_sprite_authenticated()` - Check/prompt for auth
- `get_sprite_name()` - User input for sprite name
- `ensure_sprite_exists()` - Create sprite if doesn't exist
- `verify_sprite_connectivity()` - Test sprite connection
- `run_sprite()` - Execute commands on sprite
- `setup_shell_environment()` - Configure PATH and zsh
- `try_oauth_flow()` - Attempt OAuth (can fail gracefully)
- `get_openrouter_api_key_manual()` - Manual API key entry
- `get_openrouter_api_key_oauth()` - OAuth with fallback
- `open_browser()` - Cross-platform browser launch

**Failure Scenarios Handled:**
1. Missing netcat (`nc`) command
2. Port already in use
3. OAuth server startup failure
4. OAuth timeout (2 minute default)
5. OAuth code exchange failure
6. No browser available
7. User cancellation

### Documentation
- `REFACTORING.md` - Detailed refactoring explanation
- `CURL_BASH_SOLUTION.md` - curl|bash compatibility details
- `OAUTH_FALLBACK.md` - OAuth fallback mechanism guide
- `CHANGELOG.md` - This file

### Backward Compatibility
- βœ… Scripts maintain identical functionality
- βœ… Same command-line interface
- βœ… Same environment setup
- βœ… Enhanced reliability through fallbacks

### Testing
All scripts validated with `bash -n` for syntax correctness.

**Test scenarios:**
```bash
# Local execution
bash sprite/claude.sh
bash sprite/openclaw.sh

# Remote execution (after pushing to GitHub)
curl https://raw.githubusercontent.com/.../sprite/claude.sh | bash

# Fallback testing
PATH=/tmp:$PATH bash sprite/claude.sh # Simulates missing nc
```

## Statistics

**Code Reduction:**
- openclaw.sh: 165 lines removed (-64%)
- claude.sh: 171 lines removed (-63%)
- Total duplicate code eliminated: ~330 lines
- New shared library: 203 lines
- Net reduction: ~130 lines

**Maintainability:**
- Common logic: 1 place to update (vs 2+)
- Function reuse: 12 shared functions
- Future scripts: ~90 lines instead of ~250 lines

## Migration Guide

No migration needed - scripts are backward compatible.

For developers adding new spawn scripts:
1. Source the common library
2. Use provided functions for setup
3. Add tool-specific configuration
4. Scripts automatically work with curl|bash

Example:
```bash
#!/bin/bash
set -e
source "$(dirname "${BASH_SOURCE[0]}")/lib/common.sh"

ensure_sprite_installed
ensure_sprite_authenticated
SPRITE_NAME=$(get_sprite_name)
ensure_sprite_exists "$SPRITE_NAME"
setup_shell_environment "$SPRITE_NAME"
API_KEY=$(get_openrouter_api_key_oauth)

# Tool-specific setup...
```
98 changes: 98 additions & 0 deletions CURL_BASH_SOLUTION.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
# curl | bash Compatibility

## The Problem

When running scripts via `curl URL | bash`:
```bash
curl https://example.com/script.sh | bash
```

**What happens:**
- Script is piped directly to bash (no file on disk)
- `${BASH_SOURCE[0]}` = `-` or `bash` (not a file path)
- Cannot use `source ./lib/common.sh` (no local files exist)

**Result:** Original refactoring would fail ❌

## The Solution

Scripts now detect their execution context and adapt:

```bash
if [[ -n "${BASH_SOURCE[0]}" && "${BASH_SOURCE[0]}" != "-" && "${BASH_SOURCE[0]}" != "bash" ]]; then
# Local: source from filesystem
source "$SCRIPT_DIR/lib/common.sh"
else
# Remote: download from GitHub
source <(curl -fsSL https://raw.githubusercontent.com/.../lib/common.sh)
fi
```

## Trade-offs

### βœ… Pros
- Works with both `curl | bash` and local execution
- Maintains code reusability (no duplication)
- Single source of truth for shared functions
- Easy to update (fix once, affects all scripts)

### ⚠️ Cons
- **Network dependency**: curl | bash requires downloading library
- **Single point of failure**: If GitHub is down, scripts fail
- **Cache opportunity**: Library is downloaded every time (not cached)
- **Trust model**: Users must trust both the script AND library URLs

## Alternative Approaches

### Option A: Inline Everything (Original Scripts)
```bash
# Pros: No external dependencies, works offline
# Cons: Code duplication, hard to maintain
```

### Option B: Bootstrap Script
```bash
# Download and cache locally first, then run
curl -fsSL https://url/install.sh | bash

# install.sh does:
mkdir -p /tmp/spawn
cd /tmp/spawn
curl -O lib/common.sh
curl -O openclaw.sh
bash openclaw.sh
```

### Option C: Self-Extracting Archive
```bash
# Embed library as base64 inside script
# Decode and source in memory
```

## Recommendation

**Current solution (hybrid source) is best because:**
1. Maintains developer experience (DRY code)
2. Works with existing `curl | bash` pattern
3. Minimal complexity
4. Standard approach in OSS (see: homebrew, rustup, etc.)

## Security Note

When using `curl | bash` from multiple URLs:
```bash
# User sees this
curl https://site.com/openclaw.sh | bash

# Script internally does this
source <(curl https://raw.githubusercontent.com/.../common.sh)
```

**Recommendation for users:**
```bash
# More secure: Review before running
curl -O https://site.com/openclaw.sh
curl -O https://raw.githubusercontent.com/.../common.sh
cat openclaw.sh common.sh # Review both files
bash openclaw.sh
```
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
# Changelog

## [Unreleased] - 2026-02-06

### Added
- **Shared library architecture** (`sprite/lib/common.sh`)
- Centralized common functions across all spawn scripts
- Reduced code duplication by ~64%
- Easier maintenance and bug fixes

- **OAuth fallback mechanism**
- Automatic fallback to manual API key entry if OAuth fails
- Handles missing `nc` (netcat) gracefully
- Handles port conflicts and timeouts
- API key format validation with override option

- **Dual execution mode support**
- Scripts work locally: `bash sprite/openclaw.sh`
- Scripts work via curl: `curl URL | bash`
- Automatic detection and adaptation

- **Enhanced error handling**
- Graceful failure messages
- User-friendly prompts
- Non-fatal OAuth failures

### Changed
- **Refactored `openclaw.sh`**
- 258 lines β†’ 93 lines (-64%)
- Now uses shared library functions
- Cleaner, more focused logic

- **Refactored `claude.sh`**
- 272 lines β†’ 101 lines (-63%)
- Now uses shared library functions
- More maintainable code

- **OAuth flow improvements**
- Better error detection
- Server startup validation
- Process cleanup on failure

### Technical Details

**New Functions in `common.sh`:**
- `log_info()`, `log_warn()`, `log_error()` - Colored logging
- `ensure_sprite_installed()` - Install sprite CLI if needed
- `ensure_sprite_authenticated()` - Check/prompt for auth
- `get_sprite_name()` - User input for sprite name
- `ensure_sprite_exists()` - Create sprite if doesn't exist
- `verify_sprite_connectivity()` - Test sprite connection
- `run_sprite()` - Execute commands on sprite
- `setup_shell_environment()` - Configure PATH and zsh
- `try_oauth_flow()` - Attempt OAuth (can fail gracefully)
- `get_openrouter_api_key_manual()` - Manual API key entry
- `get_openrouter_api_key_oauth()` - OAuth with fallback
- `open_browser()` - Cross-platform browser launch

**Failure Scenarios Handled:**
1. Missing netcat (`nc`) command
2. Port already in use
3. OAuth server startup failure
4. OAuth timeout (2 minute default)
5. OAuth code exchange failure
6. No browser available
7. User cancellation

### Documentation
- `REFACTORING.md` - Detailed refactoring explanation
- `CURL_BASH_SOLUTION.md` - curl|bash compatibility details
- `OAUTH_FALLBACK.md` - OAuth fallback mechanism guide
- `CHANGELOG.md` - This file

### Backward Compatibility
- βœ… Scripts maintain identical functionality
- βœ… Same command-line interface
- βœ… Same environment setup
- βœ… Enhanced reliability through fallbacks

### Testing
All scripts validated with `bash -n` for syntax correctness.

**Test scenarios:**
```bash
# Local execution
bash sprite/claude.sh
bash sprite/openclaw.sh

# Remote execution (after pushing to GitHub)
curl https://raw.githubusercontent.com/.../sprite/claude.sh | bash

# Fallback testing
PATH=/tmp:$PATH bash sprite/claude.sh # Simulates missing nc
```

## Statistics

**Code Reduction:**
- openclaw.sh: 165 lines removed (-64%)
- claude.sh: 171 lines removed (-63%)
- Total duplicate code eliminated: ~330 lines
- New shared library: 203 lines
- Net reduction: ~130 lines

**Maintainability:**
- Common logic: 1 place to update (vs 2+)
- Function reuse: 12 shared functions
- Future scripts: ~90 lines instead of ~250 lines

## Migration Guide

No migration needed - scripts are backward compatible.

For developers adding new spawn scripts:
1. Source the common library
2. Use provided functions for setup
3. Add tool-specific configuration
4. Scripts automatically work with curl|bash

Example:
```bash
#!/bin/bash
set -e
source "$(dirname "${BASH_SOURCE[0]}")/lib/common.sh"

ensure_sprite_installed
ensure_sprite_authenticated
SPRITE_NAME=$(get_sprite_name)
ensure_sprite_exists "$SPRITE_NAME"
setup_shell_environment "$SPRITE_NAME"
API_KEY=$(get_openrouter_api_key_oauth)

# Tool-specific setup...
```
98 changes: 98 additions & 0 deletions CURL_BASH_SOLUTION.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
# curl | bash Compatibility

## The Problem

When running scripts via `curl URL | bash`:
```bash
curl https://example.com/script.sh | bash
```

**What happens:**
- Script is piped directly to bash (no file on disk)
- `${BASH_SOURCE[0]}` = `-` or `bash` (not a file path)
- Cannot use `source ./lib/common.sh` (no local files exist)

**Result:** Original refactoring would fail ❌

## The Solution

Scripts now detect their execution context and adapt:

```bash
if [[ -n "${BASH_SOURCE[0]}" && "${BASH_SOURCE[0]}" != "-" && "${BASH_SOURCE[0]}" != "bash" ]]; then
# Local: source from filesystem
source "$SCRIPT_DIR/lib/common.sh"
else
# Remote: download from GitHub
source <(curl -fsSL https://raw.githubusercontent.com/.../lib/common.sh)
fi
```

## Trade-offs

### βœ… Pros
- Works with both `curl | bash` and local execution
- Maintains code reusability (no duplication)
- Single source of truth for shared functions
- Easy to update (fix once, affects all scripts)

### ⚠️ Cons
- **Network dependency**: curl | bash requires downloading library
- **Single point of failure**: If GitHub is down, scripts fail
- **Cache opportunity**: Library is downloaded every time (not cached)
- **Trust model**: Users must trust both the script AND library URLs

## Alternative Approaches

### Option A: Inline Everything (Original Scripts)
```bash
# Pros: No external dependencies, works offline
# Cons: Code duplication, hard to maintain
```

### Option B: Bootstrap Script
```bash
# Download and cache locally first, then run
curl -fsSL https://url/install.sh | bash

# install.sh does:
mkdir -p /tmp/spawn
cd /tmp/spawn
curl -O lib/common.sh
curl -O openclaw.sh
bash openclaw.sh
```

### Option C: Self-Extracting Archive
```bash
# Embed library as base64 inside script
# Decode and source in memory
```

## Recommendation

**Current solution (hybrid source) is best because:**
1. Maintains developer experience (DRY code)
2. Works with existing `curl | bash` pattern
3. Minimal complexity
4. Standard approach in OSS (see: homebrew, rustup, etc.)

## Security Note

When using `curl | bash` from multiple URLs:
```bash
# User sees this
curl https://site.com/openclaw.sh | bash

# Script internally does this
source <(curl https://raw.githubusercontent.com/.../common.sh)
```

**Recommendation for users:**
```bash
# More secure: Review before running
curl -O https://site.com/openclaw.sh
curl -O https://raw.githubusercontent.com/.../common.sh
cat openclaw.sh common.sh # Review both files
bash openclaw.sh
```
Loading