@urbicon-ui/sv
v8.26.0
Published
Svelte CLI (sv) community add-on for Urbicon UI — installs the blocks library and the urbicon CLI, wires the Tailwind 4 stylesheet, and hands over to the design-loop onboarding.
Maintainers
Readme
@urbicon-ui/sv
The Svelte CLI community add-on for Urbicon UI — one command from an empty directory (or an existing SvelteKit project) to a working, styled setup.
Beta. sv community add-ons are experimental — the add-on API may change between sv releases. This package tracks its
svpeer range.
Usage
# New project — sv asks its own questions (TypeScript, Prettier, …):
bunx sv create my-app --add @urbicon-ui
# Existing SvelteKit project:
bunx sv add @urbicon-uiAny package manager works (npx sv … likewise); non-interactive runs (CI,
agents) should pre-answer Tailwind's plugin prompt:
bunx sv add tailwindcss=plugins:none @urbicon-ui.
Requires SvelteKit — the add-on declines a non-Kit project. The library does
not: @urbicon-ui/blocks imports neither $app/* nor @sveltejs/kit and runs
in any Svelte 5 project with Vite and Tailwind 4. What is missing outside Kit is
the wiring, not the compatibility — a non-Kit project owns its entry module, so
no add-on can know where the stylesheet gets loaded. Do those two steps by hand:
see the getting-started guide.
@urbicon-ui resolves to this package; the tailwindcss add-on is pulled in
automatically as a dependency.
What it does
- Adds
@urbicon-ui/blocks(dependency) and@urbicon-ui/design(devDependency) as a caret range floored at the release this add-on shipped with — all@urbicon-ui/*packages version in lockstep. - Adds
@import '@urbicon-ui/blocks/style/index.css';to the app stylesheet, after Tailwind. That single import carries the design tokens and the@sourcedirectives that make Tailwind generate the components' classes — no consumer-side@sourceneeded. - Points you at the next step:
bunx urbicon init --hook # AGENTS.md agent context + the edit-time design gateThe design-loop onboarding deliberately lives in urbicon init, not here: it is
idempotent, version-stamped and meant to be re-run after upgrades — things a
one-shot scaffolder cannot be.
Local development
bun run build # bundles src/index.ts → dist/index.mjs (sv stays external)
cd /path/to/test-project
bunx sv add file:/path/to/packages/sv --no-git-checkPart of the Urbicon UI monorepo; see the getting-started guide for the manual setup this add-on automates.
