@gitlab/create-ui
v2.1.0
Published
A starter project for GitLab UI
Maintainers
Keywords
Readme
GitLab Prototype Kit
A starter project for rapid GitLab UI prototyping using the design system. Includes @gitlab/ui components, @gitlab/svgs icons, and @gitlab/fonts typography.
Getting started
yarn create @gitlab/ui my-gitlab-ui-app
cd my-gitlab-ui-app
yarn install
yarn startSee the created project's README.md for more information about how to use it.
Vue version
The CLI asks which Vue version to scaffold:
- Vue 3 (
@vue/compat) — the default. Vue 3's migration build inMODE: 2, matching how GitLab runs Vue 3, withvue-router4. - Vue 2 — Vue 2.7 with
vue-router3.
Pass --vue-version compat or --vue-version 2 to skip the prompt. When stdin is not a TTY (CI,
piped input) the default is used instead of prompting, so the CLI never hangs:
yarn create @gitlab/ui my-gitlab-ui-app --vue-version 2Pass --help (or -h) to print the usage summary.
Claude Code skills
The template ships the Claude Code skills listed in
scripts/copy_skills.mjs, but does not check them in. The monorepo's
.claude/skills holds the only copy, and yarn build copies them into
template/.claude/skills. prepack runs the build, so a published package always carries the
current skills.
Run yarn build before testing the CLI from a checkout, otherwise the created project has no
skills:
yarn build
node index.js /tmp/my-test-app --vue-version compat