mlola-ui
v1.5.1
Published
Source-copy CLI that writes framework-free Mlola UI items into your project
Downloads
8,483
Maintainers
Readme
mlola-ui
The Mlola UI source-copy CLI. It writes components, blocks, pages, and templates into your project, rewrites their imports to fit it, and installs the Mlola packages they import with your package manager. Framework-free: the copied markup works in any language that can emit HTML, and React sources use only React.
The library's contract is generated from its own stylesheet, so a model reading it cannot invent a class or attribute that does not exist.
Install
npx mlola-ui init
npx mlola-ui add button sheet hero-split landing
npx mlola-ui doctorinit writes mlola.config.json, the engine stylesheet, and the instructions
your coding agents read (see below), and installs @mlola-ui/engine. It fits
the project it finds: files go where the @/ alias in tsconfig.json points,
or into src/ when there is one. Without an alias, as in a new Vite app, it
sets "imports": "relative" and the copied files import each other by
relative path, so nothing needs setting up first.
add resolves the dependency graph (a page pulls its blocks, a block pulls its
components), copies only what you asked for, and installs the packages the
copied code imports that package.json does not declare yet. Pass
--no-install to only print the command. doctor checks the project against
the registry: packages the installed items import, the engine import, the
theme attribute, and files changed since they were added.
Tailwind can stay in the project. The engine places Mlola's layers above Tailwind's preflight in either import order.
Commands
| Command | What it does |
| --- | --- |
| init [--no-agents] [--no-install] | create mlola.config.json, the stylesheet entry and the agent instructions, and install the engine |
| agents | write or refresh the agent instructions in an existing project |
| mcp | run the Mlola MCP server over stdio, for coding agents |
| add <items…> [--no-install] | copy items and their dependencies into the project, and install the packages they import |
| list [--json] | print every installable item |
| doctor | report project and registry problems |
| check [path…] [--json] [--strict] [--all] | check every file's markup and CSS against the contract, and count the colors and spacing typed by hand |
| migrate [path…] [--write] [--json] | move a shadcn/ui project's props, toasts and icons to Mlola, and list what needs a person |
| login <token> | save a Mlola Pro token (from /account) for this user |
| logout | forget the saved token |
Checking a project
check runs the same check as the MCP server's check_markup over every
HTML, JSX, TSX, Vue, Svelte, Astro and CSS file in the project (or the paths
you name), and reports each issue with its line and fix:
npx mlola-ui check # the whole project
npx mlola-ui check src --json # one folder, every issue as dataIt ends with the drift: how many different colors and spacing values were
typed by hand instead of read from the tokens, and which ones most. It works
in any project, so it can measure one before it uses Mlola. In a Mlola
project it leaves out what the CLI installed (--all takes the copied markup
in; Mlola's own stylesheets, the built theme among them, are held by the
library's gates and never checked); where
Tailwind, UnoCSS or Windi is installed it leaves utility classes alone and
counts only the values typed into them (bg-[#fafafa], p-[13px]).
It exits 1 when it finds an error (with --strict, a warning too), and on
GitHub Actions each issue is also an annotation on the pull request:
# .github/workflows/ui.yml
name: UI
on: pull_request
jobs:
mlola:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: npx -y mlola-ui@latest check srcMoving from shadcn/ui
migrate makes the changes a machine can make without guessing, and lists
the rest with the line and what to do. Mlola installs a component at the
same file shadcn/ui did (components/ui/button.tsx), so imports stay as
they are. It reads by default; --write makes the changes.
npx mlola-ui migrate # what would change, and what needs a person
npx mlola-ui migrate --write # make the changes
npx mlola-ui add button badge toast --overwrite # the command it printsIt rewrites props written out as literals (variant="destructive" becomes
variant="danger", a Badge's variant becomes its tone), moves sonner
and the older use-toast to Mlola's toast (toast.error becomes
toast.danger), switch to toggle, and the lucide-react glyphs Mlola
has to @mlola-ui/icons, in the file's own import style. It leaves a value
computed at runtime, a cva() helper and a component whose API differs
(Dialog, Select, Dropdown Menu…) to you, naming the attributes or the
component that replace each one.
Coding agents
init (or agents, in an existing project) tells the project's coding agents
that its UI is Mlola:
mlola.agents.md: the design guide, with every class,data-*value and token, and the rules for new UI;AGENTS.md: a short section between markers pointing at the guide (merged, never overwritten), andCLAUDE.mdimporting it for Claude Code;.mcp.json(and.cursor/or.vscode/when the project uses them): the Mlola MCP server.
npx mlola-ui mcp is that server. It answers from the registry bundled with
this CLI, offline: get_design_rules, search_components, get_component,
get_tokens, check_markup (invented classes, wrong data-* values, utility
classes, and hand-written colors, spacing off the --ml-space-* scale or
faded text in style attributes, <style> blocks and utility classes, each
with its line), add_components and init_project. For Claude Code
without init:
claude mcp add mlola --scope project -- npx -y mlola-ui mcpIt is started by your agent and talks over stdio, so run by hand it prints one
line and waits. The same tools, minus the two that write, answer at
https://ui.mlola.com/mcp for agents that cannot run a command (with
get_install_command, which also gives the CDN link and script for a page with
no build step), and the server
is listed in the MCP Registry as io.github.mlolahq/mlola-ui. See
https://ui.mlola.com/docs/agents for Cursor, VS Code, Codex and chat apps.
Mlola Pro
Pro components, blocks, pages and templates are not in this package. With a license, create a token at https://ui.mlola.com/account, then:
npx mlola-ui login mlp_…
npx mlola-ui add conversation botadd fetches Pro items and their Pro dependencies from the service, checks
every file against its integrity hash, and writes them like any other item.
Free dependencies still come from this package. Pro stylesheets land in
styles/mlola-pro/, gathered by styles/mlola-pro.css: import it once, after
the engine stylesheet. mlola-pro.agents.md at the project root lists every
Pro class and attribute for coding agents; point your AGENTS.md at it. In CI, set MLOLA_PRO_TOKEN instead of logging in. The
token is stored in ~/.config/mlola-ui/credentials.json, readable by you only.
Configuration
Aliases and targets live in mlola.config.json:
{
"aliases": {
"components": "@/components/ui",
"blocks": "@/components/blocks",
"pages": "@/app/pages",
"templates": "@/app/templates"
}
}The CLI works from an npm tarball with no repository checkout; the packed installation is tested in CI.
MIT licensed. Part of Mlola UI.
