@quark-hq/quark
v0.0.3
Published
Quark CLI — workspace scaffolding, package creation, and Yalc workflows for design-system monorepos
Maintainers
Readme
@quark-hq/quark
CLI for scaffolding and working with Quark design-system monorepos — pnpm + Nx workspaces, GitHub Actions workflows, Storybook, and local Yalc publishing.
Part of the Quark project.
Requirements
- Node.js 18+
pnpmandyalc(installed automatically on first run if missing)
Install
npm install -g @quark-hq/quark
# or
pnpm add -g @quark-hq/quarkCommands
| Command | Description |
| ------- | ----------- |
| quark new <project-name> | Bootstrap a new monorepo (pnpm workspace, GitHub workflows, sample button package, Storybook, .env, Dockerfile) |
| quark create <package-name> | Scaffold a new React library package (Vite or Webpack) in the current workspace |
| quark publish <package-name> | Publish a package to the local Yalc store |
| quark publish <package-name> --push | Publish and push to linked consumers |
| quark link <package-name> | Publish via Yalc and link into the current project |
| quark remove <package-name> | Remove a Yalc-linked package |
| quark remove --all | Remove all Yalc-linked packages |
| quark add-atlas [dir] | Copy the bundled Atlas (Next.js) app into the workspace (--force to overwrite) |
Examples
# New monorepo
quark new my-design-system
cd my-design-system
# Add a component package
quark create my-button
# Local dev publish
quark publish my-button --pushRelated packages
| Package | Role |
| ------- | ---- |
| @quark-hq/quark-scripts | Release, dev publish, and prod publish automation |
| @quark-hq/quark-security | Path-safety and spawn helpers used by the CLIs |
Development
From the Quark monorepo:
pnpm install
pnpm --filter @quark-hq/quark run build
pnpm --filter @quark-hq/quark run testLicense
MIT © Acko Technologies
