html-artifacts-skill
v0.3.0
Published
Install the html-artifacts skill for any SKILL.md-compatible agent or skills directory.
Downloads
313
Readme
HTML Artifacts
A portable skill for any agent that understands SKILL.md-style skills, turning dense work into self-contained browser artifacts.
Use it when a spec, plan, review, research note, incident report, design sheet, debugging trace, or decision brief would be easier to understand as a single .html file with layout, diagrams, tables, timelines, controls, or copy/export affordances.
What This Skill Does
html-artifacts helps an agent decide when HTML is the right medium and then produce a polished, self-contained artifact. The skill includes:
- a concise workflow in
SKILL.md - an artifact picker for choosing the right format
- reusable HTML/CSS/JS recipes
- a starter
base.htmltemplate - a lightweight checker for generated HTML artifacts
It is useful for:
- implementation plans and technical specs
- code review and debugging artifacts
- architecture and research explainers
- design sheets and component/state reviews
- incident/status reports
- prompt, config, and workflow editors
- meeting decks and decision briefs
Recommended Install With skills.sh
The easiest path is the skills CLI from skills.sh. This installs the create-html-artifacts skill globally for your detected agent environment:
npx --yes skills add pde201/create-html-artifacts-skill \
--skill html-artifacts \
--global \
--yesTo install for a specific agent, pass --agent. Codex:
npx --yes skills add pde201/create-html-artifacts-skill \
--skill html-artifacts \
--global \
--agent codex \
--yesClaude Code:
npx --yes skills add pde201/create-html-artifacts-skill \
--skill html-artifacts \
--global \
--agent claude-code \
--yesTo preview what the repo exposes before installing:
npx --yes skills add pde201/create-html-artifacts-skill --listFor a project-local install, omit --global.
The repo is public, so these commands work without GitHub authentication. The skills CLI supports multiple agents and can install this skill wherever that agent expects skills.
Direct npx Install
If you prefer to skip the skills CLI, this repo also exposes a direct GitHub npx installer:
npx --yes github:pde201/create-html-artifacts-skillBy default, the direct installer writes to a generic skills directory:
${AGENTS_HOME:-$HOME/.agents}/skills/html-artifactsAgent-specific shortcuts are also available:
npx --yes github:pde201/create-html-artifacts-skill codex
npx --yes github:pde201/create-html-artifacts-skill claudeFor a custom skills directory:
npx --yes github:pde201/create-html-artifacts-skill --dest "$HOME/.agents/skills"If you already have the skill installed, add --force:
npx --yes github:pde201/create-html-artifacts-skill --forceThe direct installer copies the skill into the selected agent's global skills directory. Use the skills.sh installer above when you want ecosystem-friendly install tracking and multi-agent support.
Clone-Based Install
Clone the repo, then run the installer for your agent:
gh repo clone pde201/create-html-artifacts-skill
cd create-html-artifacts-skill
./install.shRestart your agent after installing so it can discover the new skill.
Install Targets
Generic Agent Directory
./install.shInstalls to:
${AGENTS_HOME:-$HOME/.agents}/skills/html-artifactsCodex
./install.sh codexInstalls to:
${CODEX_HOME:-$HOME/.codex}/skills/html-artifactsClaude Code
./install.sh claudeInstalls to:
${CLAUDE_HOME:-$HOME/.claude}/skills/html-artifactsCustom Skills Directory
Use --dest when your agent reads skills from another folder:
./install.sh --dest "$HOME/.agents/skills"That creates:
$HOME/.agents/skills/html-artifactsOverwrite an Existing Install
The installer refuses to overwrite by default. To replace an existing copy:
./install.sh --forceVerify Installation
After a generic install, confirm the skill exists:
ls "${AGENTS_HOME:-$HOME/.agents}/skills/html-artifacts/SKILL.md"For Codex:
ls "${CODEX_HOME:-$HOME/.codex}/skills/html-artifacts/SKILL.md"For Claude Code:
ls "${CLAUDE_HOME:-$HOME/.claude}/skills/html-artifacts/SKILL.md"Then restart the agent and invoke it with:
Use $html-artifacts to turn this implementation plan into a self-contained HTML artifact.Using the HTML Checker
The skill ships with a small validation helper:
html-artifacts/scripts/check-html-artifact.py path/to/artifact.htmlIt checks for common issues such as a missing title, missing viewport tag, external dependencies, missing landmarks, unlabeled controls, and stale placeholders.
What Gets Installed
The installed skill directory contains:
SKILL.mdwith the trigger and workflowreferences/with artifact-selection guidance, reusable recipes, and pattern examplesassets/templates/base.htmlas a self-contained starter templatescripts/check-html-artifact.pyfor generated artifact checksagents/openai.yamlas optional OpenAI/Codex UI metadata. Other agents can ignore it.
Repository Layout
.
+-- install.sh
+-- package.json
+-- bin/install.js
+-- README.md
`-- html-artifacts/
|-- SKILL.md
|-- agents/openai.yaml
|-- assets/templates/base.html
|-- references/
| |-- artifact-selection.md
| |-- html-artifact-patterns.md
| `-- recipes.md
`-- scripts/check-html-artifact.pyNotes
- The skill itself has no dependency on Codex, Claude Code, or any single agent runtime.
agents/openai.yamlis optional metadata for OpenAI/Codex interfaces; other agents can ignore it.- Generated HTML artifacts should be self-contained unless the user explicitly asks for external assets or dependencies.
