Get Started with Emberflow

Emberflow works with your AI coding tools. Install once, then publish docs, diagrams, data viewers, and interactive explainers with a single command.

Quick Install

Run this in any project directory:

npx emberflow-skills

The installer auto-detects which AI tools you use and installs skills in the right format. It takes about 10 seconds.

---

Tool-Specific Setup

Claude Code

Skills install to .claude/skills/ and are available as slash commands.

# Install to current project
npx emberflow-skills

# Or install globally (available in all projects)
npx emberflow-skills --global

How to use: Type any slash command in your conversation:

Command	What it does
/ember-publish [topic]	Auto-picks the best format
/ember-publish-doc [topic]	Markdown doc with interactive diagrams
/ember-publish-explainer [topic]	Slide-based visual explainer
/ember-publish-json [data]	Interactive JSON explorer
/ember-publish-dataset [csv]	Sortable, filterable data table
/ember-publish-space [directory]	Multi-page docs site

Codex (OpenAI)

Skills install to .agents/skills/ using the same SKILL.md format.

npx emberflow-skills

How to use: Invoke skills with the $ prefix:

$ember-publish architecture overview of the auth system
$ember-publish-explainer how our CI/CD pipeline works

Cursor

Skills install as .mdc rules in .cursor/rules/. They auto-attach when the AI detects you want to publish.

npx emberflow-skills

How to use: Reference a rule with @ or just ask naturally:

@ember-publish-explainer how rate limiting works

Or simply ask:

Publish this module's architecture to Emberflow

Windsurf

Skills install as rules in .windsurf/rules/. They're loaded automatically into every conversation.

npx emberflow-skills

How to use: Just ask naturally:

Create an Emberflow doc explaining the payment flow
Publish a visual explainer about our database schema

---

Authentication

During installation, you'll be prompted to sign in. This links published docs to your account so you can manage them from your dashboard.

If you skip sign-in, docs are published anonymously. You can claim them later by signing in and running:

npx emberflow-skills --auth

---

What You Can Publish

Documents

Markdown with interactive architecture diagrams (auto-laid-out, no coordinates), syntax-highlighted code, and auto-generated table of contents.

Visual Explainers

Slide-based interactive presentations. The AI picks the best visualization for each slide — funnels, heatmaps, radar charts, timelines, architecture diagrams, and more.

JSON Explorers

Paste JSON data and get an interactive explorer with a node-graph view, expand/collapse, search, and multi-payload tabs.

Datasets

Publish CSV files as sortable, filterable tables with virtual scroll (handles 10k+ rows), per-column filters, and CSV export.

Spaces

Publish a directory of markdown files as a multi-page docs site with sidebar navigation and SPA page transitions.

---

Manual Install

If you prefer not to use npx:

git clone https://github.com/pmccurley87/emberflow-skills.git

# Claude Code
cp -r emberflow-skills/skills/* .claude/skills/

# Codex
cp -r emberflow-skills/skills/* .agents/skills/

MCP Server

Emberflow also provides an MCP server for direct API access from any MCP-compatible tool. See the MCP documentation for setup instructions.