LIFEHUBBER
Choose theme

AI Resources

DESIGN.md

GitHub stars: 28.2K GitHub forks: 2.3K Declared license: Apache-2.0: Apache-2.0 Last pushed October 1, 2026: Pushed today
Stats from GitHub

DESIGN.md is a file format and CLI toolkit from Google Labs Code for giving coding agents a project’s visual rules. It puts design tokens and the reasons for using them in a reference that stays with the project.

Use it when the next coding session needs the same colours, type and component guidance as the last one, rather than rebuilding that context in each prompt. Use this as a first read, not a recommendation. Open the original project before trusting details like terms, limits, privacy, cost, setup, or safety.

What it is

A file the agent can read

Optional YAML frontmatter holds machine-readable tokens. Markdown sections explain the visual identity and how to apply it. This supplies guidance; it does not make an agent follow every rule.

Why it stands out

Checks beside the written guidance

The CLI validates structure, compares token changes and exports tokens. These are checks on the design file, not a review of the interface an agent produces.

Availability

Specification, examples and npm package

The repository publishes the format, example files and the @google/design.md CLI. You can author the reference without running a coding assistant; the CLI needs Node.js 18 or later.

Why it matters

What makes it useful

A colour name in prose and a token value do different jobs. The specification makes the tokens authoritative; the prose explains their use. Keep a precise value in the token rather than expecting a description such as “forest green” to specify it for the agent.

Notable points

What stands out

The diff command reports token changes and returns a failure when the later file has more errors or warnings. Lint returns a failure for errors; warnings alone do not fail it. Read the findings as well as the exit code: a passing lint run can still have a warning about a component’s text/background contrast.

Before using

What to review

The specification’s current format version is alpha. Keep the version and exported format in mind when connecting it to existing token tools.

On Windows, the design.md executable name can collide with the Markdown file association. The documented dot-free command is npx -p @google/design.md designmd lint DESIGN.md.

Check the actual rendered interface separately. A declared colour-pair check cannot establish accessibility for the whole product.

Reader fit

Who may find it relevant

Designers who already know the product’s visual rules and want to explain them to coding agents.

Developers who want token changes and the written rationale reviewed with their project files.

Someone seeking a tool that invents a complete design system still needs to supply the design decisions; this format records and checks them.

Editorial note

Why LifeHubber lists it

Before making an export part of your build, give lint its own check. Since CLI 0.4.0, a successful export returns exit code 0 even when the source has lint errors or warnings. Use lint’s findings to decide whether the source is acceptable, then export it; if warnings must block your build, check those explicitly too. An export success means the output was serialized, not that the design reference passed validation.

Source links

Source materials

Reader note

Before relying on this entry

LifeHubber lists entries to help readers inspect AI projects, not to endorse them or prove they are safe, suitable, accurate, maintained, or right for a specific use. We do not verify every entry in depth. Before relying on anything listed, review the original materials, terms, privacy practices, limits, and risks that matter for your situation.

Advertisements

Advertisements

For project maintainers

Listed here? You can use the badge.

If you maintain a project with a current LifeHubber listing, you may add the optional “Listed on LifeHubber AI Resources” badge to its README, docs, or website. No introduction or permission request is needed.

See what’s moving