πŸ–₯️ Canvas-OS

Canvas as an app platform. Build, store, and run rich visual apps on the OpenClaw Canvas.

MIT-0 Β· Free to use, modify, and redistribute. No attribution required.
⭐ 7 · 2.3k · 12 current installs · 13 all-time installs
MIT-0
Security Scan
VirusTotalVirusTotal
Benign
View report β†’
OpenClawOpenClaw
Benign
high confidence
βœ“
Purpose & Capability
Name/description claim 'Canvas as an app platform' and included files (templates, open/close scripts, canvas-inject.py) align: the skill needs python3 to serve apps via http.server, navigate Canvas, and inject HTML/JS. No unrelated binaries or credentials are requested.
β„Ή
Instruction Scope
SKILL.md and scripts instruct the agent to start a localhost server, navigate Canvas to http://localhost:PORT, and/or inject arbitrary HTML via document.write() using canvas eval. This is coherent with the purpose, but it inherently allows arbitrary JS to run inside Canvas (including code that issues openclaw:// deep links or loads external resources). That capability can be used for legitimate two-way communication but also can be abused to exfiltrate data or trigger agent actions if untrusted HTML is opened.
βœ“
Install Mechanism
There is no install spec that downloads remote code; repository is instruction-and-file based. All code is provided in the package (shell scripts, Python helper, templates). No external URLs, archives, or network installs are performed by the skill itself.
βœ“
Credentials
The skill requires only python3 (declared). There are no required environment variables or credentials; an optional CANVAS_APPS_DIR env var is referenced for app location. No unexplained secrets or cross-service credentials are requested.
β„Ή
Persistence & Privilege
always:false and default model invocation settings are conservative. The scripts write PID files to /tmp and start/stop local servers but do not modify other skills or system-wide agent configs. Note: if the agent is allowed to invoke skills autonomously, the ability to inject HTML/JS that can call openclaw:// deep links increases the blast radiusβ€”this is expected behavior for this skill but worth considering in your agent policy.
Assessment
This skill is internally consistent and does what it claims, but it enables running arbitrary HTML/JS inside the Canvas sandbox. Before installing or opening apps: 1) Only open templates or HTML you trust β€” review app HTML/JS for network calls, eval() usage, and openclaw:// deep links. 2) Prefer running new/untrusted apps in a disposable environment (separate user account or VM) and bind them to non-sensitive ports. 3) Verify that your agent will not automatically act on openclaw:// messages in a risky way (check agent policies or disable autonomous invocation if you want manual control). 4) The scripts start/kill local servers and write PID files to /tmp β€” ensure these behaviors are acceptable and modify scripts if you need stricter process isolation. 5) If you plan to allow other users to provide apps, audit their code for exfiltration (fetch/XHR/fetch to external hosts) and for deep link triggers. If you want help hardening usage patterns (sanitizing templates, running in a sandbox, or adding confirmation prompts for agent actions triggered by apps), ask and I can provide concrete changes.

Like a lobster shell, security has layers β€” review code before you run it.

Current versionv1.0.1
Download zip
latestvk973wpjbz2128v95r79c9x01nd80cj6t

License

MIT-0
Free to use, modify, and redistribute. No attribution required.

Runtime requirements

πŸ–₯️ Clawdis
Binspython3

SKILL.md

Canvas OS

Canvas as an app platform. Build, store, and run rich visual apps on the OpenClaw Canvas.

Philosophy

You are an OS. Canvas is the window. Apps are built locally and run on Canvas.

Rich HTML/CSS/JS UIs β€” not just text. Full interactivity, animations, live data.

Quick Commands

CommandWhat Jarvis Does
"Open [app]"Start server, navigate Canvas, inject data
"Build me a [type]"Create app from template, open it
"Update [element]"Inject JS to modify live
"Show [data] on canvas"Quick A2UI display
"Close canvas"Stop server, hide Canvas

How It Works

Key principle: Apps run on Canvas, not in a browser tab. Canvas is your UI window.

Canvas Loading Methods

Canvas has security restrictions that block file path access. Three methods work:

MethodWhen to UseProsCons
Localhost ServerComplex apps, external assetsFull browser featuresRequires port management
Direct HTML InjectionQuick displays, demosInstant, no server neededNo external assets, size limit
Data URLsSmall contentSelf-containedUnreliable on some systems

❌ Does NOT work: file:///path/to/file.html (blocked by Canvas security)

πŸ“– See: CANVAS-LOADING.md for detailed guide + troubleshooting

Helper script: canvas-inject.py β€” Formats HTML for direct injection

1. Apps are HTML/CSS/JS files

~/.openclaw/workspace/apps/[app-name]/
β”œβ”€β”€ index.html    # The UI (self-contained recommended)
β”œβ”€β”€ data.json     # Persistent state
└── manifest.json # App metadata

2. Serve via localhost

cd ~/.openclaw/workspace/apps/[app-name]
python3 -m http.server [PORT] > /dev/null 2>&1 &

3. Navigate Canvas to localhost

NODE="Your Node Name"  # Get from: openclaw nodes status
openclaw nodes canvas navigate --node "$NODE" "http://localhost:[PORT]/"

Important: This opens the app on Canvas (the visual panel), NOT in a browser.

4. Agent injects data via JS eval

openclaw nodes canvas eval --node "$NODE" --js "app.setData({...})"

Note: The openclaw-canvas:// URL scheme has issues in current OpenClaw versions. Use http://localhost: instead.

Opening an App

What this does: Displays the app on Canvas (the visual panel), not in a browser tab.

Method 1: Localhost Server (Recommended for Complex Apps)

Full sequence:

NODE="Your Node Name"
PORT=9876
APP="my-app"

# 1. Kill any existing server on the port
lsof -ti:$PORT | xargs kill -9 2>/dev/null

# 2. Start server
cd ~/.openclaw/workspace/apps/$APP
python3 -m http.server $PORT > /dev/null 2>&1 &

# 3. Wait for server
sleep 1

# 4. Navigate Canvas
openclaw nodes canvas navigate --node "$NODE" "http://localhost:$PORT/"

# 5. Inject data
openclaw nodes canvas eval --node "$NODE" --js "app.loadData({...})"

Method 2: Direct HTML Injection (For Quick Displays)

When to use: File paths don't work in Canvas (security sandboxing). Data URLs can be unreliable. Use this for instant displays without localhost.

# Example using canvas tool
canvas.present(url="about:blank", target=node_name)

html_content = """<!DOCTYPE html>
<html>
<head>
    <style>
        body { background: #667eea; color: white; padding: 40px; }
        .card { background: white; color: #333; padding: 30px; border-radius: 16px; }
    </style>
</head>
<body>
    <div class="card">
        <h1>Your Content Here</h1>
    </div>
</body>
</html>"""

# Escape backticks and inject
js_code = f"""document.open();
document.write(`{html_content}`);
document.close();"""

canvas.eval(javaScript=js_code, target=node_name)

Key limitation: File paths (file:///path/to/file.html) are blocked in Canvas for security. Always use localhost or direct injection.

Building Apps

App API Convention

Every app should expose a window.app or window.[appname] object:

window.app = {
  // Update values
  setValue: (key, val) => {
    document.getElementById(key).textContent = val;
  },
  
  // Bulk update
  loadData: (data) => { /* render all */ },
  
  // Notifications
  notify: (msg) => { /* show toast */ }
};

Two-Way Communication

Apps send commands back via deep links:

function sendToAgent(message) {
  window.location.href = `openclaw://agent?message=${encodeURIComponent(message)}`;
}

// Button click β†’ agent command
document.getElementById('btn').onclick = () => {
  sendToAgent('Refresh my dashboard');
};

Templates

Dashboard

Stats cards, progress bars, lists. Self-contained HTML.

  • Default port: 9876
  • API: dashboard.setRevenue(), dashboard.setProgress(), dashboard.notify()

Tracker

Habits/tasks with checkboxes and streaks. Self-contained HTML.

  • Default port: 9877
  • API: tracker.setItems(), tracker.addItem(), tracker.toggleItem()

Quick Display (A2UI)

For temporary displays without a full app:

openclaw nodes canvas a2ui push --node "$NODE" --text "
πŸ“Š QUICK STATUS

Revenue: \$500
Users: 100

Done!
"

Port Assignments

App TypeDefault Port
Dashboard9876
Tracker9877
Timer9878
Display9879
Custom9880+

Design System

:root {
  --bg-primary: #0a0a0a;
  --bg-card: #1a1a2e;
  --accent-green: #00d4aa;
  --accent-blue: #4a9eff;
  --accent-orange: #f59e0b;
  --text-primary: #fff;
  --text-muted: #888;
  --border: #333;
}

Best Practices

  1. Self-contained HTML β€” Inline CSS/JS for portability
  2. Dark theme β€” Match OpenClaw aesthetic
  3. Expose app API β€” Let agent update via window.app.*
  4. Use IDs β€” On elements the agent will update
  5. Live clock β€” Shows the app is alive
  6. Deep links β€” For two-way communication

Troubleshooting

App opens in browser instead of Canvas?

  • Make sure you're using openclaw nodes canvas navigate, not just open
  • Canvas navigate targets the Canvas panel specifically

"Not Found" on Canvas?

  • File paths don't work: Canvas blocks file:/// URLs for security (sandboxing)
  • Data URLs may fail: Use direct HTML injection via canvas eval + document.write() instead
  • For localhost: Verify server is running: curl http://localhost:[PORT]/
  • Check port is correct
  • Use http://localhost: not openclaw-canvas:// (URL scheme has issues)

Canvas shows "Not Found" even with correct URL?

  • This is a security boundary: Canvas can't access local filesystem
  • Solution: Use Method 2 (Direct HTML Injection) from "Opening an App" section
  • Or serve via localhost (Method 1)

App not updating?

  • Check window.app API is defined: openclaw nodes canvas eval --js "typeof window.app"
  • Verify JS eval syntax: single quotes inside double quotes

Server port already in use?

  • Kill existing: lsof -ti:[PORT] | xargs kill -9

Helper Scripts

canvas-inject.py

Python helper for direct HTML injection (Method 2).

# Example usage in Python
from canvas_inject import inject_html_to_canvas

html = open("my-dashboard.html").read()
commands = inject_html_to_canvas(html, node_name="Your Node")

# Then use canvas tool with these commands
canvas.present(**commands["step1_present"])
canvas.eval(**commands["step2_inject"])

Or just follow the pattern manually (see Method 2 in "Opening an App").

Requirements

  • OpenClaw with Canvas support (macOS app)
  • Python 3 (for http.server)
  • A paired node with canvas capability

Files

9 total
Select a file
Select a file to preview.

Comments

Loading comments…