Integrations

Plug Explainers.fyi into the agents your team already uses.

The companion skill is the fastest path when your agent can load reusable instructions. If it cannot, fall back to the direct upload API and keep the same output contract.

Supported agent setups

Claude Code Cursor GitHub Copilot OpenAI Codex Cline

Skill-first

Use the public explainer skill

The recommended path is the companion skill at github.com/heysarver/explainer-skill. Set EXPLAINERS_API_KEY in the agent environment and let the skill publish automatically after it generates HTML.

Install the skill

Add the shared explainer skill or copy its instructions into the agent’s custom workflow system.

Export your API key

Make EXPLAINERS_API_KEY=xp_live_... available in the agent shell so uploads can authenticate automatically.

Run the explainer command

Have the agent generate the HTML and publish it in the same flow. The resulting URL is what you share with stakeholders.

API-first

Fallback for any agent

If your tool can write files and make HTTP requests, it already has everything it needs. Generate HTML, then POST it to the upload endpoint with the same bearer key.

curl -X POST https://explainers.fyi/api/v1/upload \
  -H "Authorization: Bearer $EXPLAINERS_API_KEY" \
  -F "file=@./explainer.html;type=text/html" \
  -F "title=Auth flow overview" \
  -F "description=Explain the GitHub login pipeline" \
  -F "visibility=public"

Use the skill when you want opinionated prompts and automatic publishing
Use the API directly when your agent only needs a stable upload target
Handle the returned sanitized flag so operators know if the HTML was modified