Quickstart
Run Artifacts locally and publish your first artifact in a few commands.
Core concepts
Understand artifacts, versions, workspaces, and the access model.
How it works
1
Publish content
Send an HTML, Markdown, or JSX file from the CLI, REST API, or an MCP tool. The first publish creates an artifact and its version 1.
2
Get a durable URL
Each artifact lives at a stable path and renders safely in the browser — sandboxed HTML, sanitized Markdown, or the Preact runtime for JSX.
3
Update without losing history
Every update appends a new immutable version. Old versions stay addressable, so you can diff or restore them anytime.
4
Share with the right people
Keep it public, private, email-allowlisted, or behind a scoped share link — without ever changing the URL.
What you can publish
Every artifact gets a path shaped like this:
Ways to connect
Artifacts is multi-surface by design. People work in the dashboard; agents and automation use the same core model through programmable interfaces.Web app
Dashboards, artifact viewing, version history, access settings, and billing.
CLI
The agent-friendly command line for local scripts and coding agents.
REST API
The canonical HTTP contract behind the web app and CLI.
MCP server
Structured artifact tools for MCP-capable agents.
Key ideas
A few terms show up everywhere in these docs:- Workspace — a personal or team namespace, such as
aliceoracme. - Project — a group of artifacts inside a workspace, such as
defaultorlaunch-review. - Artifact — the stable object: a title, slug, type, access settings, and a pointer to its latest version.
- Version — an immutable snapshot of source content, tracked by SHA-256 hash with an optional changelog.
- Principal — whoever is making the request: a user, API key, OAuth client, agent, or service.
- Access policy — the one authorization layer enforced identically across web, API, CLI, and MCP.
Start building
Follow the quickstart to publish your first artifact from the CLI.