skip to content
shortwind
Docs/Core

Docs/Core

Getting started

A two-minute tour of Shortwind.

Getting started

Shortwind is a build-time class layer for Tailwind. Write @card instead of the fifteen Tailwind tokens that make up a card. At build time, every @recipe shorthand expands into its full Tailwind class list. The CSS your users download is identical to plain Tailwind — Shortwind only shrinks the source.

Why bother?

  • LLM artifacts shrink. A Claude-generated dashboard goes from ~3,200 tokens of class soup to ~900 tokens of @recipe shorthand. Same render.
  • You read what you wrote. A line that says class="@card-elevated" tells you what the element is, not what it looks like.
  • No new runtime. Shortwind compiles down to Tailwind. If Tailwind ships it, Shortwind ships it.

Install

npx @shortwind/cli@beta init

The CLI (the @shortwind/cli package — beta for now) detects your bundler, installs the matching adapter, copies a recipes/ directory you own, scaffolds a default theme, and generates a SKILL.md so your agents know the recipe palette. On Vite it also wires the plugin into your bundler config; on Next/Astro it prints the one-line snippet to paste.

See install for the full walkthrough.

Core or Cloud?

These docs cover two products, split by the switcher at the top of the sidebar:

  • Core (these pages) is the build-time class layer you install into your own project. It compiles @recipe shorthand to plain Tailwind and ships nothing new to the browser.
  • Cloud is agent-native hosting: publish an HTML file and get a live URL, with recipes expanded server-side. If you want us to host the output rather than build it yourself, start with What is Cloud.