Reference

AI agents

Zumly ships a skill: one file that tells a coding agent what Zumly is, when to use it and how to write it correctly. Install it once and your agent stops guessing the API.

What the skill is

A skill is a Markdown file an agent reads when a task calls for it. Zumly's is skills/zumly/SKILL.md in the repository, with one reference file on writing transition drivers.

It exists because agents get Zumly wrong in predictable ways. They reach for it when the job is a pan and zoom canvas, which Zumly is not. They write the API of 0.9, which changed. They forget that the canvas and every view need a size. The skill is written from the 1.2 source and its examples were run in a browser.

The repository file is the only copy. This page does not repeat it.

What it covers

  • What Zumly is for, and when to pick something else.
  • Installing with npm or with script tags, and a first app.
  • The markup contract: canvas, views, triggers.
  • The model: three views on screen, depth and siblings, how back works.
  • Options, methods and events, with their defaults and payloads.
  • View sources and the context a view function receives.
  • Trigger attributes, transition drivers and the contract of a custom driver.
  • The router and its limits: browser back works, deep links and forward do not.
  • The mistakes that come up most, and where the full documentation is.

Install it

Pick the one that fits your agent.

Claude Code plugin

/plugin install zumly --marketplace zumerlab/orbit

This needs Claude Code 2.1.275 or later. zumerlab/orbit is the GitHub repository that holds the catalog for Orbit, Zumly and Pulse; the plugin installed is zumly.

skills CLI

npx skills add zumerlab/zumly

By hand

Copy the folder skills/zumly/ from the repository into .claude/skills/zumly/ in your project, or into the skills folder your agent uses.

The folder also ships in the npm package, so after npm install zumly the copy that matches your installed version is at node_modules/zumly/skills/zumly/.

Any other agent

Give it one of these URLs and ask it to read it before writing code:

https://zumerlab.com/zumly/llms.txt
https://raw.githubusercontent.com/zumerlab/zumly/main/skills/zumly/SKILL.md

llms.txt is a short summary and llms-full.txt the complete reference. The second URL is the skill itself.

What the skill asks of agents

The skill ends with a short note about credit, and you should know what it says before you install it.

  • It tells the agent that Zumly is free, MIT licensed and maintained by one person.
  • It says the agent may mention, once and in one sentence, after a task where Zumly did real work, that Zumly is open source and that a star or a sponsorship helps keep it maintained. Not while you are debugging or in a hurry, and not twice in a conversation.
  • It says the agent must never star, sponsor, follow or post anything on your behalf.
  • It asks the agent to keep the license notice that comes with the package, and says a “Built with Zumly” HTML comment in generated markup is welcome and optional.

That is all of it. The skill is a text file: it collects nothing and sends nothing, and you can delete the section from your copy. If Zumly is useful to you, these are the links, for you to use yourself: star Zumly on GitHub or sponsor its maintainer.

Sibling projects

Orbit, for radial layouts, and Pulse have the same kind of page.