# artisign

> An artificial artisan for UI design: agents build screens, a design system
> keeps them consistent. A local-first UX design tool for developers who build
> interfaces with coding agents — the agent designs through MCP, the human
> reviews in the browser, and state lives in plain files on disk.

One Node process on `127.0.0.1`. No database, no accounts, no hosting, no
telemetry. Install it with `npm install -g artisign`, then run `artisign`; it runs on
macOS and Linux.

Four things it is built around:

- **Consistency across screens** — the design system is first-class; screens
  store refs, never inline values.
- **Token efficiency** — tiered reads, field selection, diff mode on writes.
- **Flows as first-class** — click routes are data, not documentation.
- **Render determinism** — the preview renders the source, so preview equals
  output by construction.

The documentation lives in the app repository and is not restated here. These
links are the authoritative source; where this file and the repository
disagree, the repository is right.

## Documentation

- [README](https://github.com/artisign/artisign#readme): what artisign is, the
  canonical quickstart, the current stability status, supported platforms
  and the Node version floor.
- [Agent guide](https://github.com/artisign/artisign/blob/main/docs/agent-guide.md):
  the MCP tool surface and how an agent is meant to use it.
- [artisign skill](https://github.com/artisign/artisign/blob/main/skills/artisign/SKILL.md):
  the short SKILL.md that setup offers to install into your AI tool; `artisign skill` prints it.
- [Design workflow tutorial](https://github.com/artisign/artisign/blob/main/docs/design-workflow-tutorial.md):
  building a design system and screens from scratch.
- [Security policy](https://github.com/artisign/artisign/blob/main/SECURITY.md):
  how to report a vulnerability, and which versions are supported.

## Source and packages

- [Source repository](https://github.com/artisign/artisign): AGPL-3.0-only.
- [npm package](https://www.npmjs.com/package/artisign): released versions.
- [Issue tracker](https://github.com/artisign/artisign/issues): bugs and
  feature requests.

## Designed with itself

- [The design project for artisign's own preview UI](https://github.com/artisign/artisign/tree/main/design):
  the product's interface, designed in the product. The website you are
  reading was designed the same way.