README.md

September 20, 2026 · View on GitHub

Archify

Turn anything you want to understand, plan, or share into an interactive visual.

Start with an idea, a question, or a plan. Describe it to your AI agent, and Archify turns it into an interactive HTML you can explore, customize, and share. From travel itineraries and learning maps to complex systems—make it your own.

See what the community is creating—and imagine what you could make next.

Live demos  ·  Get started  ·  Scenario guide  ·  Community  ·  简体中文

tt-a1i/archify | Trendshift

GitHub stars MIT License Agent Skill Development version 2.17.0-dev.1

Archify website Join Archify on Discord Archify WeChat group Archify QQ group Follow the creator on X

See Archify in action

Three verified Archify artifacts moving through Signal Flow, Blueprint, and Classic presets
Three real generated artifacts. Signal Flow · Blueprint · Classic · open the interactive Proof Lab ↗

Click the preview to open real interactive artifacts. The GIF shows the motion; the HTML lets you explore it yourself.

Install, then describe your idea

Works with Cursor, Claude Code, Codex CLI, and OpenCode. See installation options below for additional integrations.

npx skills add tt-a1i/archify -g

Send this to your agent:

Use Archify to diagram a web request: Browser calls the API,
the API checks Redis, and a cache miss queries PostgreSQL and fills the cache.

Then continue: “Add authentication”, “Highlight the cache-miss path”, or “Switch to the light theme”.

No repository is required: start with a description, or ask your agent to read a repository for a source-backed architecture diagram.

Choose your agent · Installation details and update checks

❤️ Sponsors

Supercode
supercode.sh
Supercode sponsors Archify and enhances Codex and Cursor with token optimization, curated Skills, and spec-driven development. Archify is featured as a Supercode Editor’s Choice skill.

Supercode Editor’s Choice — Archify
Archify × Raven
EverMind · Raven
EverMind sponsors Archify and builds memory infrastructure for agents. Its Raven harness supports Archify as a Skill for verified, interactive system maps.

Want to sponsor Archify? Contact us by email.

Show what matters

Explain an agent workflowFollow a cache missExplore service relationships
Agent workflow playing one authored chapterCache-miss sequence showing the Web App to Postgres routeProduction architecture comparing backend and database roles
Walk through the steps defined in the diagram.Highlight the path from web app to database.Focus on authored backend and database connections.

The Proof Lab contains all 11 checked-in scenarios, their JSON sources, named views, and validation receipts.

Understand a real repository

CODE → DIAGRAM · A source-backed system map

MCO runtime architecture generated from the public mco-org/mco repository

Archify traced mco-org/mco at 9f1a1cf and produced this checked map. Open it ↗ · trace reach ↗ · typed source

Easy to extend. More ways to make it yours.

COMMUNITY STORIES · Selected examples shared by users

Keep building after the diagram is generated. Archify is open source and its output is standalone HTML. Ask your agent to adapt it, connect useful links, or add interactions for your own workflow. Community creations already span team collaboration, travel planning, legal citation checks, contract review, and incident retrospectives. These are just a few examples.

One user started with a hand-drawn multi-agent architecture, turned it into an interactive diagram, then added a Kimi execution pool through conversation. Others asked their agent to read a project and brought the resulting architecture into Feishu or DingTalk for team discussion.

Another user turned a Shanghai CityWalk guide into a four-day itinerary: switch between days, inspect a stop, and jump to Amap, Xiaohongshu, or Dianping. The author also added arrival check-ins and stop notes, turning the itinerary into a small tool to use during the trip. These extensions were added by the community author for this particular artifact.

▶ Explore the interactive Shanghai CityWalk

A community-created four-day Shanghai CityWalk itinerary

▶ Try the interactive version · Switch between D1–D4 and click a place to explore.

Community artifact · Shanghai CityWalk · Four days of routes and place links

Download it. Open it. Explore it.

The output is a self-contained HTML file. Download it and open it in your browser to use the node details, path exploration, and guided chapters included in that artifact. No Archify installation is needed to view it. Send the HTML to someone else and the interactions go with it; external websites and map links need a network connection.

Explore the Shanghai CityWalk ↗ · Download HTML ↓

Try switching between D1–D4, opening a place card, or following a map link. Times and place information reflect the author's original itinerary.

Community and recognition

A selection of public coverage, community shares, and historical milestones. Follow the links for dates and sources.

Preview

Themes, exports, and share cards

Archify — interactive diagrams

Same diagram, two themes, one click to switch:

DarkLight
Dark themeLight theme

The Export menu copies PNG to the clipboard and downloads static or motion formats:

Export menu

Use Copy Share Card when you want a canonical 1200×630 image for a README, release, or social post.

After tracing a route, Export → Route Share Card downloads that authored path as a 1200×630 PNG with the full diagram retained for context.

Route Share Card showing the exact Users to API Server path with the full architecture retained as context

After tracing authored Upstream or Downstream reach, Export → Reach Share Card captures that exact reading without claiming runtime impact.

MCO downstream Reach Share Card showing authored relationships from Command Router

Open examples/web-app.html locally to try the complete viewer.

Quick start

Current development version: v2.17.0-dev.1. See Changelog.

1. Install

npx skills add tt-a1i/archify -g
More installation options and update-check details

For an explicit, non-interactive Cursor install:

npx -y skills add tt-a1i/archify --skill archify --agent cursor --global --copy --yes

To try without installing:

npx skills use tt-a1i/archify@archify --agent codex

DSH community opt-in: dsh plugin --profile web add @tt-a1i/archify-dsh@0.1.0

The agent switcher covers cursor, codex, claude-code, and opencode. For Raven's manual ZIP install, extract archify.zip into ~/.raven/workspace/skills; it yields ~/.raven/workspace/skills/archify. Raven is not a switcher target.

Archify may GET the fixed stable manifest solely to show an optional reminder; it never downloads or installs updates. Successful checks wait about 72 hours (±20%); active use retries failures after 6, then 24 hours. The server sees normal HTTP metadata (IP and time), but receives no version, Agent, project data, prompts, account/device ID, or ETag. You decide whether and when to update. Set ARCHIFY_UPDATE_CHECK_DISABLED=1 to disable networking and reminder-state writes.

2. Start from a description — no repository required

Use Archify to draw: Browser -> API -> Redis cache -> PostgreSQL fallback.

For source evidence, open a repository and ask:

Analyze this repository, then use archify to create a high-level runtime architecture diagram.
Show 8–12 core components, one primary path, external dependencies, and trust boundaries.
Put supporting detail in cards instead of adding more edges.

3. Refine in chat

Continue with focused requests such as add Redis, move auth to the left, or highlight the rollback path. Archify keeps the typed source available for targeted iteration.

Choose the right diagram

Five diagram types, architecture comparisons, and examples
TypeBest forInclude in your prompt
ArchitectureComponents, services, storage, boundariesScope, core components, primary path
WorkflowCI/CD, approvals, tool calls, runbooksParticipants, order, branches, exceptions
SequenceAPI calls, cache fallback, auth, async tracesCallers, callees, returns, timing
Data FlowPipelines, lineage, PII, consumersSources, transforms, stores, boundaries
LifecycleStates, retries, waits, terminal outcomesStates, events, retry and cancellation paths

Architecture's optional deployment-ownership profile fails closed when authored owners, region placement, private database scope, or named crossings are missing; it is never implicit and does not inspect live infrastructure. See the checked deployment proof.

For design or PR review, Architecture Delta compares validated Before / Delta / After snapshots with a machine receipt. Select an authored change or play one finite, viewer-only Review; it infers no impact, risk, or merge safety.

node archify/bin/archify.mjs compare architecture base.json head.json architecture-delta.html --json

Architecture Delta showing added, removed, changed, and moved authored facts

Not sure which one fits? Use the interactive scenario guide, or ask the zero-dependency CLI:

node archify/bin/archify.mjs guide "Show an API request with Redis cache miss"
node archify/bin/archify.mjs guide "Map Kafka topics, consumer groups, replay, and DLQ" --json

Workflow keeps the happy path clear across lanes:

Workflow example

Sequence explains one interaction over time:

Sequence example

Data Flow makes movement and sensitivity boundaries explicit:

Data Flow example

Lifecycle separates progress, waits, retries, and terminal outcomes:

Lifecycle example

Architecture examples: web-app · Archify pipeline · grid placement · desktop agent

Why Archify

Understand the structureWalk through the story
Map components, workflows, and relationships from code or a description.Explore nodes, follow paths, and explain a process chapter by chapter.
Extend it your wayShare the result
Keep an editable source and build on the open-source code or generated HTML with your own interactions and use cases.Share a self-contained HTML file or export images, video, and share cards.
The engineering behind the experience
  • Layout judgment over generic auto-layout — the agent chooses hierarchy, spacing, routes, and emphasis; shared automatic endpoints spread deterministically instead of piling arrows on one midpoint.
  • Typed JSON IR — every renderer-backed mode has a schema and reproducible source.
  • Atomic validation before delivery — schema, layout, HTML/SVG, route, and label-to-route clearance checks must all pass before a showcase artifact replaces the last known good output.
  • Failures come with a repair receiptvalidate --json and deliver --json return stable rule codes, the exact subject, measured evidence, and only supported repair controls instead of a Node stack or an unstructured retry guess.
  • Last-good live preview — an optional desktop loop watches one JSON file, refreshes only after the latest candidate passes every gate, and keeps the previous verified diagram visible when a save is incomplete or invalid.
  • Truthful interaction — focus, upstream/downstream reach, exact routes, role comparison, and stories reuse authored nodes and relationships instead of inventing topology or claiming runtime impact.
  • Source evidence, only when requested — Evidence-backed Architecture nodes mark themselves SRC n and open Git-verified files and line ranges pinned to one public commit; ordinary artifacts stay source-free.
  • Portable by default — the result is one HTML file; exports remain full-diagram and free of temporary viewer state.

Archify is not a general-purpose drawing editor or a Mermaid theme. It turns technical intent into a communication artifact.

How it works

Generation, validation, preview, and delivery details
StepWhat happens
GenerateThe agent creates typed JSON IR from your description.
ValidateBundled validators and layout rules check the source; failures identify the exact local repair in machine-readable JSON.
Preview (optional)A loopback-only desktop session watches one source and reloads only verified revisions; failures keep the last-good artifact.
DeliverA same-directory candidate is rendered and checked; only a passing artifact atomically replaces the target, then optional --open launches that exact file.
IterateThe agent updates the source while unrelated structure stays stable.

Useful repository commands:

cd archify
node bin/archify.mjs doctor
node bin/archify.mjs demo /tmp/archify-demo
node bin/archify.mjs guide "Show CI/CD checks, approval, deploy, and rollback"
node bin/archify.mjs validate workflow examples/agent-tool-call.workflow.json --quality showcase --json
node bin/archify.mjs preview workflow examples/agent-tool-call.workflow.json /tmp/workflow.html --quality showcase
node bin/archify.mjs deliver workflow examples/agent-tool-call.workflow.json /tmp/workflow.html --quality showcase --open --json

preview is an explicit loopback-only desktop mode: it watches one JSON file on a random 127.0.0.1 port, keeps the last verified output through failures, stops with Ctrl-C, and adds no generated-HTML runtime. Use --no-open for tests or manual URL opening.

deliver --open is an opt-in one-shot handoff after commit. Opener failure preserves success; JSON remains on stdout and the absolute fallback path goes to stderr.

On failure, validate --json and deliver --json emit one JSON object. Apply only each diagnostics[] subject's supportedFixes, within the Skill's two correction rounds; visual review remains separate.

Settings:

{
  "meta": {
    "locale": "en",
    "animation": "trace",
    "visual_preset": "signal-flow"
  }
}

meta.locale=en|zh-CN localizes page title, Legend, states/errors, a11y, HTML/SVG lang—never authored content. Otherwise omit; preserve requested-language copy; disclose English fallback. Static omits animation; classic defaults.

Explore and share the output

ActionControl
Open the factual Diagram Guide?
Find and focus a semantic node/
Trace upstream/downstream authored reachFocus a node → Upstream / Downstream
Probe a directed route and inspect its journeyR or PATH
Compare one or two semantic rolesL or LENS
Open the live overview radarM or MAP
Play a guided story / change chapterP / [ ]
Enter Presentation StageF
Choose visual style (S cycles) / toggle theme / open ExportS / T / E
Zoom or reset+ / - / 0

Stable links can restore #focus=<id>, #focus=<id>&reach=upstream|downstream, #relation=<id>, #route=<source>~<target>, #lens=<kind>~<kind>, and #view=<view-id>. Reader-driven motion is finite, respects prefers-reduced-motion, and never enters canonical exports.

The complete generation and viewer contract lives in archify/SKILL.md.

Installation options

SurfaceInstall location or methodCapability
RavenManual ZIP into ~/.raven/workspace/skills~/.raven/workspace/skills/archifyFull renderer + validation workflow
Claude Code~/.claude/skills/ or .claude/skills/Full renderer + validation workflow
Codex CLI~/.agents/skills/ or .agents/skills/Full renderer + validation workflow
opencode~/.config/opencode/skills/, .opencode/skills/, or .agents/skills/Full renderer + validation workflow
Claude.aiUpload archify.zip under Settings → Capabilities → SkillsDepends on Node.js access in the sandbox
Project KnowledgeUpload archify.zip to the projectPrompt-driven architecture fallback
DeepSeek HarnessOpt-in: dsh plugin --profile web add @tt-a1i/archify-dsh@0.1.0. Invoke: Use the archify skill to map this repository's runtime architecture. Remove: dsh plugin --profile web remove @tt-a1i/archify-dsh.Community integration for developer-preview @deepseek-ai/dsh@0.1.0-rc.6; Node ^22.19.0 || >=24.0.0; not an official DeepSeek product. No telemetry. Shell files need exact workspace paths, not Web Produced Files. Details.

Reference and scope

Automatic Mermaid parsing, general-purpose auto-layout, hosted sharing, and WYSIWYG editing are intentionally outside the current scope.

Community

👋 Welcome to the Archify Community!

Connect with other users and developers, share ideas, request features, report bugs, discuss development, and help make Archify better together.

  • Discord
  • WeChat: scan the QR code below. WeChat group codes expire periodically; if this one has expired, ask for the current code through Discord or QQ.
  • QQ group: 1121948602
WeChat
Archify Official WeChat group QR code
QQ
Archify Official QQ group QR code

License

MIT — free to use, modify, and distribute.

Contributing

Issues, pull requests, and real-world diagrams are welcome. Start with the contribution guide, use the reproducible bug form for failures, or submit a validated diagram through the community showcase form. · LINUX DO

Star History

Star History