Docs
How to install Artifac in your agent, what one artifact needs, and how it keeps data between visits.
Install
Install the Artifac plugin wherever your agent supports plugins. It connects your agent to Artifac and adds the Artifac skill, which teaches it to publish pages, update them, and keep their saved data.
Claude Code
In a Claude Code session, run:
/plugin marketplace add LeeorNahum/ Artifac-Plugin/plugin install artifac@artifacOr, from a terminal:
claude plugin marketplace add LeeorNahum/ Artifac-Plugin && claude plugin install artifac@artifacClaude app
Claude on the web, the desktop app, and Cowork. One account carries the plugin to all three and to Claude Code.
Open Customize, then Plugins.
Choose Add, then Add marketplace, and enter:
LeeorNahum/Artifac-Plugin Install Artifac.
In the plugin's Connectors tab, connect its connector.
Codex
The Codex CLI and Codex in the ChatGPT desktop app share their settings, so one install covers both.
In a terminal, run these three. The last one signs you in.
codex plugin marketplace add LeeorNahum/ Artifac-Plugincodex plugin add artifac@artifaccodex mcp login artifacCursor
Open Customize, then Plugins.
Choose Add Marketplace, then Import from GitHub, and paste:
https://github.com/LeeorNahum/ Artifac-Plugin Install Artifac.
VS Code with Copilot
Add the marketplace to the
chat.plugins.marketplacessetting, which VS Code marks as experimental:LeeorNahum/Artifac-Plugin In the Extensions view, search for this, then install Artifac:
@agentPlugins
Gemini CLI
In a terminal, run:
geminiextensions install https://github.com/ LeeorNahum/ Artifac-Plugin Then, in a Gemini CLI session, sign in with:
/mcpauth artifac
Install the connector
In apps without plugins, or if you prefer, add Artifac as a connector, also called a remote MCP server. It needs no key, because you sign in instead.
The connector gives your agent Artifac's tools. If your agent also takes skills, add the Artifac skill by copying it into its skills folder, as the skill's repository describes.
ChatGPT
ChatGPT on the web and on mobile.
Open chatgpt.com/plugins, choose +, then Add custom MCP server.
Enter this address, then choose Create:
https://mcp.artif.ac/mcp
Windsurf (Devin Desktop)
Add Artifac as a connector at this address:
https://mcp.artif.ac/ mcpOther apps
Add this address as a remote MCP server, also called a connector, and sign in when it asks:
https://mcp.artif.ac/ mcpSigning in
Your agent signs in to Artifac through your browser. Sign in, or create a free account, and approve the connection. Most apps open the sign-in page the first time they use Artifac, and Codex opens it with its sign-in command.
The connection covers your whole account: every workspace you belong to now or join later, plus the artifacts people share with you, until you revoke it. What it can do in each workspace follows your role there, checked on every call, so leaving a workspace or losing a share ends that access at once.
To revoke one app's access, open Connected agents in the Artifac app and choose Revoke. Its next call is refused, even after it renews its sign-in. To let it back in, choose Allow again there, or approve it when it next asks you to sign in.
Sharing, visibility, subdomains, Trash, and billing stay in the Artifac app. An agent can read who can do what, but it cannot change those settings.
The eight tools
Every tool works on files by their paths inside an artifact, and every change names the artifact by its ID.
- list_workspaces
- Lists the workspaces you belong to, with your role in each.
- list_artifacts
- Finds artifacts across your workspaces and the ones shared with you, by search, workspace, and sort.
- read_artifact
- Reads an artifact's details and its list of files, or one file, including saved data.
- create_artifact
- Makes a new artifact in a workspace from files that include index.html. It is live as soon as the call returns.
- update_artifact
- Adds or replaces several files at once. Replacing a file needs a fresh read of it, so two agents never overwrite each other.
- edit_artifact_file
- Changes one text file by replacing an exact passage, the way coding agents edit code.
- delete_artifact_files
- Deletes files by path. The entry page, index.html, always stays.
- delete_artifact
- Moves an artifact to Trash, where an Owner can restore it for 30 days.
One HTML file is enough
An artifact needs an index.html and nothing else. Add CSS, JavaScript, images, and more pages as ordinary files beside it. Static output from a framework works too. Artifac serves files and never runs server code.
The head of index.html names the artifact. Its title names it in the library and the browser tab, its link rel="icon" is the tab icon, and library search also looks through its meta name="description". Link previews use the title, the description, and an optional og:image. Without an image, Artifac makes a preview card for you.
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Packing list</title>
<meta name="description" content="What to bring to Lisbon.">
<link rel="icon" href="icon.svg">
<meta property="og:image" content="preview.png">
</head>
<body>
<h1>Packing list</h1>
</body>
</html>Each artifact gets a permanent address, artif.ac/ followed by its ID. An Owner can also give it a subdomain in the app, and it then opens at yourname.artif.ac.
Saved data
An artifact keeps data between visits in collections of records. Code in the page saves one record at a time, and your agent sees each collection as a JSON file it reads and edits with the same tools as any other file:
.artifac/config.jsonsets each collection's rules..artifac/data/<collection>.jsonholds one collection's records, the ones you are allowed to see.
{
"collections": {
"items": { "read": "shared", "write": "any" },
"rsvps": { "read": "own", "write": "own" }
}
}"read": "shared"lets everyone who can open the artifact see every record."read": "own"shows each person only the records they made, while Editors and Owners see them all."write": "any"lets anyone who can see a record change it, like a shared checklist."write": "own"lets anyone add records and only their author change them, like a form."write": "editors"leaves writing to Editors and Owners.- A collection the configuration does not name is shared, and anyone can write to it.
Changing the code never resets saved data. When your agent replaces a file it has not read, or one that changed since it read it, the change is refused so nobody else's is lost, and the agent reads the file again and reapplies its own.
HTTP API and CLI
Scripts and integrations use the HTTP API at https://api.artif.ac/v1, described at https://api.artif.ac/openapi.json. It does what the eight tools do, and it is also how large files are uploaded.
From a terminal, run the CLI with npx artifac. It reads files from your disk, so it is the easy way to publish a folder.
Limits
Each plan sets how many artifacts, subdomains, and bytes an account holds. They are listed on the pricing page, and a call that would cross one fails with an error naming the limit.