CLI

الـ boardui تنسخ CLI ملفات مصدر المكوّنات مباشرةً إلى مشروعك — دون حزمة وقت تشغيل، الشيفرة ملكك. تحل كل تبعيات المكوّن الداخلية (الأدوات المساعدة والأيقونات والمكوّنات الأخرى) بشكل متعدٍّ وتثبت أي حزم npm مفقودة باستخدام مدير الحزم الخاص بك.

npx boardui@latest add button select date-picker

init

يُعدّ BoardUI في مشروع Next.js قائم: يثبّت تبعيات وقت التشغيل (react-aria-components, tailwind-merge, @remixicon/react، Tailwind v4)، ويكتب styles/theme.css, styles/typography.css, styles/globals.css، و utils/cx.ts، ثم يطبع الأسطر التي يجب إضافتها إلى التخطيط الجذري: استيراد ورقة الأنماط وخط Inter.

عندما يترجم المشروع Tailwind v4 بالفعل، كما يفعل create-next-app 16.4 وما بعده عبر @tailwindcss/turbopack، لا يغيّر init إعداد PostCSS. وإلا فإنه يثبّت @tailwindcss/postcss ويطبع سطر postcss.config.mjs. مرّر --postcss لإعداد PostCSS في الحالتين.

npx boardui@latest init
خيارالوصف
-y, --yesSkip confirmation prompts
-o, --overwriteOverwrite existing files
-d, --dir <dir>Target directory (defaults to the project source root)
--proAlso install dependencies used by BoardUI Pro components
--postcssSet up @tailwindcss/postcss even when Tailwind already compiles another way

إضافة

يضيف مكوّناً واحداً أو أكثر. بشكل افتراضي، تحتفظ الملفات بنفس البنية الموجودة في هذا الموقع (components/base/…, components/application/…) تستخدم الاستيرادات @/ alias، ويتم تخطي الملفات الموجودة ما لم تمرر --overwrite. شغّله بدون وسيطات للحصول على منتقٍ تفاعلي.

npx boardui@latest add # interactive pickernpx boardui@latest add table paginationnpx boardui@latest add --all
خيارالوصف
-a, --allAdd every component in the registry
-p, --path <path>Custom directory to write files into
-d, --dir <dir>Target directory (defaults to the project source root)
-o, --overwriteOverwrite existing files
-y, --yesSkip prompts — keep existing files, install dependencies

CI والسكربتات ووكلاء البرمجة

يسأل init وadd قبل تثبيت الحزم أو تعديل الملفات الموجودة. وعند عدم وجود طرفية للإجابة، كما في CI أو سكربت أو وكيل برمجة، يتوقفان برمز الخروج 1 بدلًا من التخمين. مرّر --yes لقبول الإعدادات الافتراضية: تثبيت الاعتماديات والإبقاء على الملفات الموجودة. أضف --overwrite لاستبدال الملفات الموجودة، واذكر أسماء المكونات أو مرّر --all بدلًا من استخدام أداة الاختيار.

npx boardui@latest init --yesnpx boardui@latest add button select --yes

مسارات مخصصة والمستودعات المتعددة

إضافة خيار boardui.json بجانب حزمة الوجهة package.json لتهيئة وجهة الملفات وأسماء الاستيراد المختصرة التي تستخدمها. كلاهما init و إضافة قراءته، بما في ذلك مكوّنات Pro. بدونه، سيظل الجذر الحالي و src/ تعمل التخطيطات كما كانت من قبل.

تهيئة المقترن paths و aliases إدخالات للمكوّنات، والأدوات المساعدة، والخطافات، والأنماط، أو المكتبة. شغّل CLI داخل الحزمة الوجهة حتى تُثبَّت تبعيات npm هناك أيضاً. لا يمكن دمج التعيينات المُهيَّأة مع --path أو --dir؛ تبقى تلك العلامات متاحة للمشاريع غير المهيّأة. لا يُهاجر تغيير الإعداد الملفات المثبَّتة مسبقًا.

تهيئة حزمة واجهة مستخدم مشتركة والتطبيقات المستهلكة

قائمة

يطبع كل مكوّن متاح مجمّعاً حسب النوع — المكوّنات الأساسية، وكتل التطبيق، والأسس.

npx boardui@latest list

مهارة

يثبّت مهارة وكيل BoardUI (SKILL.md بالإضافة إلى الكتالوج، والتخصيص، ومراجع الأنماط) حتى تحمّل مساعدات الذكاء الاصطناعي مثل Claude Code وCodex معرفة BoardUI في كل جلسة. الافتراضي هو .claude/skills/boardui؛ أعد التشغيل باستخدام --force للتحديث.

npx boardui@latest skill
خيارالوصف
-g, --globalInstall to ~/.claude/skills/boardui instead of the project
-c, --client <client>Install to ~/.agents/skills/boardui (codex, gemini)
-p, --path <dir>Custom directory to install the skill into
-f, --forceOverwrite an existing install (how you update)

تحديث المكوّنات

المكوّنات المثبّتة هي نسخ ملكك لتعديلها، ولن تُمسّ بصمت. لسحب أحدث إصدار من مكوّن من السجل، أعد تشغيل إضافة مع --overwrite.

npx boardui@latest add button --overwrite

قياس مجهول الهوية

بعد نجاح init، يُرسل CLI حدثًا مجهولًا يحتوي على إصداره ومدير الحزم الخاص بك وما إذا كان --pro تم استخدامه. بعد نجاح إضافة، يرسل أسماء المكوّنات التي طلبتها صراحةً، دون التبعيات المحلولة تلقائيًا. بعد نجاح مهارة عند التثبيت، يُرسل موضع وضع المهارة (مشروع، أو عام، أو مجلد الوكلاء)، دون إرسال المسار نفسه. يتيح معرّف عشوائي في مجلد إعدادات المستخدم بنظام التشغيل لديك التمييز بين عمليات التشغيل المتكررة. لا يُرسل BoardUI مسارات المشاريع، أو الشيفرة المصدرية، أو أسماء التبعيات، أو عناوين البريد الإلكتروني، أو وسائط الأوامر الأخرى، أو بيانات القياس عن بُعد لـ قائمة.

تعطيل القياس عن بُعد عبر ضبط BOARDUI_TELEMETRY_DISABLED=1 أو DO_NOT_TRACK=1.

تُحتفظ بالأحداث كعدادات مدى الحياة وحاويات يومية مجهولة تُستخدم لإعداد تقارير الاتجاهات اليومية والأسبوعية والشهرية. لا تنتهي صلاحية الحاويات اليومية تلقائياً.

التوافق مع shadcn

يستخدم السجل مخطط عنصر shadcn، لذا يمكن تثبيت كل مكوّن أيضاً باستخدام shadcn CLI إذا كنت تفضل ذلك:

npx shadcn@latest add https://www.boardui.com/r/button.json