Chuyển tới nội dung

Pro đang mở bán trước. Cài đặt mở từ tháng 1/2027. Xem Pro

Tài liệu

Cài đặt

Werewolf gồm token và component React. Bắt đầu với CLI alpha werewolf-ui đã có trên npm: init thiết lập app, rồi add cài các component bạn cần.

1. Yêu cầu

Node 20+, React 19 và Tailwind CSS v4 trong app Next.js app-router hoặc Vite React TypeScript. Thiết lập compiler alias cho import component. Chạy lệnh trong thư mục app, hoặc dùng --cwd để chọn app trong workspace.

2. Khởi tạo app

npx werewolf-ui init

Chạy init một lần. Lệnh tạo werewolf.json, tokens/seed.json và styles/werewolf.css, thêm CSS import sau import Tailwind, và cài luật cho agent. Seed hợp lệ đã có được giữ nguyên. Bạn không cần tự thêm CSS import.

CLI nhận diện package manager từ lockfile hoặc trường packageManager. Nếu chưa có cả hai, chọn rõ bằng --package-manager npm chẳng hạn. Nếu có nhiều lockfile hoặc thông tin không khớp, hãy chọn rõ app và package manager.

3. Thêm component

npx werewolf-ui add button
npx werewolf-ui add button input dialog

Sau init, thêm một hoặc nhiều component theo tên. Add cài các dependency component và package, ánh xạ import theo compiler alias của app, và giữ nguyên seed cùng theme đã tạo. File có nội dung giống nhau được bỏ qua.

4. Đổi theme

Xem thử theme bằng panel Giao diện trên header: màu accent, độ ám xám và bo góc. Nút Copy lệnh cho bạn lệnh theme với các lựa chọn đó, hoặc thay <hex> bên dưới bằng mã hex bạn chọn. Lệnh theme cập nhật seed và stylesheet của app. Bạn có thể đặt thêm --gray-tint và --radius-base (sharp, default, round, pill); các lựa chọn không truyền vào được giữ nguyên.

npx werewolf-ui theme --accent "<hex>"

Dùng theme để đổi theme do CLI quản lý. Thay stylesheet đã tạo bằng file tải về được tính là chỉnh sửa của bạn, nên lần tạo sau cần chỉ định ghi đè.

5. Đưa luật cho agent

Init cài .agents/skills/werewolf-design/SKILL.md, một phần do CLI quản lý trong AGENTS.md và .cursor/rules/werewolf.mdc. Cho agent đọc design skill trước khi viết UI. Cấu hình MCP là bước riêng.

Công cụ CLI

Với script và agent code, thêm --yes --json vào lệnh CLI để chấp nhận thao tác đã lên kế hoạch và nhận kết quả có cấu trúc. Mỗi lệnh đều có --help. API component vẫn ở trạng thái draft trong bản alpha.

CLI giữ nguyên chỉnh sửa của bạn: --yes không ghi đè chúng. Xem xét xung đột trước khi truyền --overwrite cùng đường dẫn chính xác của file đã tạo. Add cần chỉ định ghi đè cho file component có nội dung khác, kể cả dependency. Khi ghi file thất bại, CLI hoàn tác file nhưng không hoàn tác việc cài package.

Kiểm tra style

npx werewolf-ui lint src --json
npx werewolf-ui lint src --fix --yes --json

Lint báo vi phạm style tĩnh. --fix chỉ áp dụng chỉnh sửa đã xác định chắc chắn. Màu chưa xác định rõ vẫn là lỗi kèm gợi ý; style động vẫn là cảnh báo. Kiểm tra phạm vi đã phân tích ngay cả khi mã thoát là 0.

Kết nối agent qua MCP

Thêm cấu hình tiến trình này vào phần MCP của client tương thích. Thay /absolute/path/to/app bằng thư mục đã tồn tại. Bản alpha được ghim phiên bản cung cấp năm công cụ chỉ đọc: list_components, search, get_component, generate_theme và lint. Init không thay đổi cài đặt client.

{
  "command": "npx",
  "args": [
    "--yes",
    "werewolf-ui@0.1.0-alpha.0",
    "mcp",
    "--cwd",
    "/absolute/path/to/app"
  ]
}

Client cần Node 20+ và npx trên PATH. Lần chạy đầu tải package; sau đó catalog trong package dùng được offline. MCP không cài component, sửa file hay ghi theme vào app. Stdout dành cho giao thức; thông báo lỗi dùng stderr. Dùng CLI riêng để áp dụng thay đổi.

Xuất token

Xuất token của app đã khởi tạo vào thư mục bạn chọn. Dùng --platform web, ios hoặc android; mặc định là web. Chạy lệnh riêng cho từng nền tảng bạn cần. Bản native chứa token với kích thước cho cảm ứng, chưa có component native.

npx werewolf-ui tokens build --platform ios --out exported-tokens

Tìm tài liệu và tùy chọn lệnh

npx werewolf-ui docs button
npx werewolf-ui add --help

Docs in URL trang của component, hoặc trang cài đặt nếu không truyền tên. Lệnh chỉ mở trình duyệt trong terminal tương tác. Site mô tả phiên bản mới nhất và có thể khác bản alpha bạn đang cài.

Cách khác: registry và cài thủ công

Dùng cách này nếu bạn đang cài component qua registry công khai. Lệnh thêm component, các dependency và styles/werewolf.css. Luồng này không khởi tạo CLI Werewolf hay cài luật cho agent.

npx shadcn add https://www.werewolf-ui.dev/r/button.json

Import stylesheet một lần trong CSS gốc, sau @import "tailwindcss", bằng đường dẫn tính từ file đó. Từ app/globals.css, dòng import là:

@import "../styles/werewolf.css";

Với cách cài thủ công này, dùng panel Giao diện trên header (Copy CSS hoặc Tải werewolf.css) và thay styles/werewolf.css. Copy design skill vào thư mục mà agent đọc luật.

Chỉ cần stylesheet token mặc định? Tải tokens.css.