@open-canvas/core
v0.5.0
Published
Runtime, Vite plugin and CLI for open-canvas — an agent-native whiteboard framework.
Downloads
68
Readme
@open-canvas/core
Runtime, Vite plugin and CLI for open-canvas — a whiteboard framework built for AI coding agents.
What it provides
- Runtime — infinite canvas viewer, sectioned PPT-style present mode, in-browser Inspector, mini-map.
- Vite plugin — auto-discovers
boards/<id>/index.{tsx,jsx,ts,js}, exposes them asvirtual:open-canvas/boards, hot-reloads on add/remove. Optionally injectsdata-oc-locattributes for the Inspector. - CLI —
open-canvas dev | build | preview | export pdf <board>.
Public API
import { defineBoard, defineSection, defineConfig } from '@open-canvas/core'The runtime mounts itself via:
import { mount } from '@open-canvas/core/runtime'
mount(document.getElementById('oc-root'))End users normally don't import these directly — @open-canvas/cli init generates a minimal workspace and the bin commands wrap everything.
