English · 简体中文
Formerly
baoyu-design. This project started as baoyu-design (the old URL redirects here), which brought claude.ai-style Artifact types to local coding agents as one skill per type. Open Artifact rebuilds them as an open, agent-agnostic format: one local daemon, one page frame, one/open-artifactskill, and a plugin for each agent app.
Open Artifact lets any coding agent make things people can open, edit and comment on, not just files. You ask your agent for a slide deck, a UI design, a design system, a whiteboard, a spreadsheet, a data dashboard or a doc. The agent writes a plain folder of files. A local page opens it in a real editor, where you can fix a title, move a sticky note, leave comments, and export. Then "Send to agent" sends your comments back to the agent's session.
Everything runs on your machine. No account, no upload, no specific model or vendor.
you ──"/open-artifact slides a 6-slide pitch"──▶ agent (Claude Code, Codex, Cursor, Copilot, …)
│ writes files
▼
./my-deck/project/deck.json + slides/*.html
│ served by the local daemon
▼
you ◀── edit · comment · export (PDF/PPTX/PNG/HTML) ── http://127.0.0.1:<port>/a/<id>
└──────────────── "Send to agent" ──────────────▶ comments arrive back in the agent's session
| Type | What you get | Folder marker | Exports |
|---|---|---|---|
| Slides | A 1920×1080 deck: slide rail, overview, speaker notes, builds, transitions, presenter mode | project/deck.json |
PDF, PPTX, HTML, PNG |
| Design | An infinite canvas of live .dc.html artboards: screens, components, click-through prototypes, notes, pages |
project/canvas.json |
PNG, JPEG, PDF, HTML |
| Design System | A brand book: tokens, colors with contrast checks, type specimens, live component previews, assets. Designs and decks can install it | project/design-system.json |
— |
| Whiteboard | A shared infinite board: stickies, shapes, arrows, ink, images, tables, embeds, live cursors, timer | db/board/meta.json |
PNG |
| Sheets | A shared spreadsheet: several sheets of cells, a full formula engine, number formats, borders, merged cells, tables with filters, dropdowns, checkboxes, conditional formats, frozen and grouped rows, charts from cells, CSV import, cell history | sheet/sheet.json |
XLSX, CSV |
| Data | A live dashboard or report: datasets from CSV/JSON/text uploads, live MCP connector queries or calculations, drawn by a plain HTML/CSS/d3 page; Sources shows where each number comes from; filters, hand edits, remix drafts | db/dash/meta.json |
PDF, HTML, JSON |
| Docs | A living document in tabs: headings, lists, tables, pictures, dates, mentions and dropdowns; suggested edits to accept or reject, comments, a version history per tab; imports Markdown, Word and PDF | doc/doc.json |
Markdown, Word, PDF, HTML |
Each type folder is a self-contained skill: SKILL.md tells the agent how to write it, reference/ documents the
file format, artifact-type.json describes it to hosts, and scripts/ (built) holds the CLI and editors.
Install Node.js 22.18+, then download open-artifact-plugins.zip from the Assets section of a
GitHub Release. Extract it to a permanent location and use the
extracted open-artifact-plugins/ folder in the steps below. The plugins include the skill, daemon and editors.
DeepSeek Harness installs its prebuilt package directly from npm.
| Agent app | Install |
|---|---|
| Claude Code (CLI, desktop, IDE) | Add the extracted root as a marketplace, then install open-artifact@open-artifact. |
| Codex (CLI, app) and ChatGPT desktop | Add the extracted root with codex plugin marketplace add, then install Open Artifact in Plugins. |
| Cursor | Copy the extracted cursor/ folder to ~/.cursor/plugins/local/open-artifact, then run Developer: Reload Window. |
| GitHub Copilot CLI | Add the extracted root as a marketplace, then install open-artifact@open-artifact. |
| GitHub Copilot in VS Code | Run Chat: Install Plugin from Source and select the extracted copilot/ folder. |
| Antigravity | Install the extracted antigravity/ folder with agy plugin install or copy it to ~/.gemini/config/plugins/open-artifact, then restart the app. |
| ChatGPT on the web | Run the prebuilt connector from the extracted chatgpt/ folder and connect it over HTTPS. |
| DeepSeek Harness | In Plugins, choose Add plugin and enter dsh-open-artifact as the npm package. In the CLI, run dsh plugin --profile web add dsh-open-artifact for the web profile. |
To upgrade, download the new ZIP, replace the extracted folder at the same path, and follow your app's update steps in the linked guide. If your marketplace still points to a source checkout, register the extracted folder using the migration steps in your app's guide.
In DeepSeek Harness, use Update on the Open Artifact page when a new version is offered. If you previously
linked a local checkout, remove the linked plugin in Plugins and add dsh-open-artifact from npm.
In a new session, try one of these prompts.
/open-artifact slides a 6-slide pitch for this repo
/open-artifact design three landing page options for a coffee shop
/open-artifact whiteboard a retro board for last sprint
/open-artifact sheets a monthly budget with categories and totals
/open-artifact data a dashboard of signups by month from signups.csv
/open-artifact docs a hiring plan for 2027 with roles, budget and timeline
The plugin adds the Artifact, ArtifactData and ArtifactComments MCP tools, the skill, and hooks that bring
page comments back into the session. How each app gets comments back, and what was tested in each, is in
plugins/README.md.
Copy codex/skills/open-artifact/ from the extracted plugin bundle to your agent's skill directory. It carries
the daemon, and the agent drives it from the command line. From the extracted bundle root, you can try:
node codex/skills/open-artifact/scripts/open-artifact.mjs artifact '{"action":"list","scope":"types"}'After building from source, every built type folder runs by itself, without the daemon:
node artifact-types/design/scripts/cli.mjs open ./my-design --type design # starts a local server, prints the URL
node artifact-types/design/scripts/cli.mjs wait ./my-design # blocks until someone presses "Send to agent"Other commands: check, generate, upload, context, comments, history, share, status, stop, … Run the
CLI with no arguments for the full list.
From a source checkout, install dependencies and build the workspace and plugin folders.
npm ci
npm run build
node scripts/build-plugins.mjsFor local plugin development, use dist/plugins/ wherever the installation guides use the extracted folder.
npm run typecheck
npm test # unit tests (node --test)
npm run e2e # end-to-end: drives the built types with the CLI and Chrome, see e2e/README.mdThe Rust crates in crates/ compile to WebAssembly. Their output is committed under packages/wasm-*/generated/,
so you only need Rust when you change a crate:
node scripts/build-wasm.mjs # needs cargo + wasm32-unknown-unknown, wasm-bindgen, wasm-optnode scripts/build-npm.mjs stages the npm packages in dist/npm/: the @open-artifact/* libraries (compiled to
JavaScript with type declarations), @open-artifact/cli (the open-artifact command with the daemon vendored) and
dsh-open-artifact. To release:
- Raise the versions (every package and plugin manifest shares one version).
- Run
node scripts/changelog.mjsfor the commits since the last tag, and add a## [x.y.z] - dateentry at the top of CHANGELOG.md that says what changed for people using it (Added / Changed / Fixed), plus its compare link at the bottom. - Commit, then push a tag (
v0.9.0). The Publish to npm workflow requires a changelog entry for the tag. It publishes new package versions through npm trusted publishing, attachesopen-artifact-plugins.zipto the tag's GitHub release and uses the changelog entry as its release notes.
A package npm doesn't have yet is claimed once from a computer before its first release:
node scripts/publish-npm.mjs --claim publishes its staged version and sets the workflow as its trusted publisher.
node scripts/publish-npm.mjs publishes from a computer too (--dry-run to look first).
| Path | Contents |
|---|---|
artifact-types/ |
The seven types as skills: SKILL.md, reference/, artifact-type.json. |
skills/open-artifact/ |
The one /open-artifact <type> skill; vendor/ (built) carries the daemon. |
plugins/ |
The skill packaged per agent app, with hooks and MCP config (README). |
| Platform | |
packages/daemon |
The open-artifact daemon: type registry, artifact library, agent tools, MCP, wake routing, the Harness API. |
packages/shell |
The daemon's pages: the Shell frame around every artifact, and the home page. |
packages/protocol |
Typed contracts shared by the daemon, harness adapters, type servers, the Shell and pages. |
packages/runtime |
window.openartifact, the capability API pages use (files, uploads, user, agent, presence, downloads). |
packages/type-server, packages/server-sdk |
The per-type local server and cli.mjs; shared server code. |
| Types | |
packages/slides-core, slides-editor |
Slides model (HTML subset, deck.json) and editor. |
packages/design-core, design-editor, dc |
Design model (canvas.json), editor, and the .dc.html artboard format. |
packages/design-system-core, design-system-editor |
Design System model (token grammar, CSS compiler) and editor. |
packages/whiteboard-core, whiteboard-editor |
Whiteboard model (schema, live sync, geometry) and editor. |
packages/sheets-core, sheets-editor |
Sheets model (workbook, cells, styles, tables, charts) and editor. |
packages/data-core, data-editor |
Data model (datasets, queries, rules, the dashboard page) and editor. |
packages/docs-core, docs-editor |
Docs model (blocks and characters with ids, ops, suggestions, markdown) and editor. |
| Shared | |
packages/live-store |
Live document sync shared by Whiteboard and Data. |
packages/ui, editor-kit, export-kit |
UI kit (Base UI + Tailwind), what editors share (comments, history, presence…), browser-side exports. |
packages/canvas-engine, wasm-*, crates/ |
WebGL2 canvas engine and the Rust/WebAssembly crates behind it, exports, whiteboard geometry, data rules and the sheets formula engine. |
e2e/ |
End-to-end tests. |
scripts/ |
build.mjs, build-plugins.mjs, build-skill.mjs, build-wasm.mjs. |
Apache License 2.0. Copyright 2026 Jim Liu 宝玉; see NOTICE.