Service: Excalidraw - EyevinnOSC/community GitHub Wiki

Excalidraw

Excalidraw (serviceId excalidraw-excalidraw) is an open source virtual whiteboard for sketching hand-drawn-like diagrams, wireframes and notes collaboratively. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance. License: MIT. Source: excalidraw/excalidraw.

What it can do

  • Draw on an infinite canvas with shapes, arrows, lines, text and freehand strokes.
  • Collaborate in real time through a shared session link.
  • Export drawings as PNG, SVG or .excalidraw files.

Creating an instance

Call create-service-instance with serviceId: "excalidraw-excalidraw". The instance name must be alphanumeric and at most 20 characters. No configuration and no other OSC service is required.

{ "name": "myboard" }

Wait with wait-for-service-ready (or get-instance-status) and read the URL with describe-service-instance.

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric/underscore only, at most 20 characters.

The service has no other options and no secrets.

Using the instance

Open the instance URL; the whiteboard is ready without login. The toolbar offers rectangle, ellipse, diamond, arrow and line shapes, text, freehand draw and an eraser.

  • Collaboration: click the Live collaboration button (person icon, top right) and share the session link. All participants see changes instantly.
  • Export: open the hamburger menu (top left) and choose Export image to save as PNG, SVG or Excalidraw file. The .excalidraw format keeps all element data and can be re-imported with Load in the same menu.

CLI usage

osc create excalidraw-excalidraw myboard

Resources