Memulai
Prasyarat
- Node.js 18+
- Tema atau plugin WordPress tempat Anda ingin menginstal blok
Paket blockstudio di npm berada pada versi 0.0.1. Rilis tersebut hanya placeholder: paket ini hanya memiliki perintah add, yang mencetak Adding block: <name> lalu berhenti tanpa mengambil apa pun, dan menolak init, list, search, remove, --yes, dan --dry-run sebagai opsi yang tidak dikenal. Perintah di halaman ini menjelaskan implementasi registry CLI dalam repositori Blockstudio (packages/registry).
Inisialisasi proyek
Jalankan init di direktori utama tema atau plugin Anda:
npx blockstudio init
CLI memandu Anda melalui penyiapan interaktif:
- Direktori blok: tempat blok harus diinstal (default:
blockstudio) - Registry: tambahkan satu atau beberapa URL registry beserta namanya
Ini membuat file blocks.json:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
Anda juga dapat melewati prompt interaktif:
npx blockstudio init --yes
Ini membuat blocks.json dengan nilai default. Setelah itu, Anda dapat mengeditnya secara manual.
Tambahkan blok
npx blockstudio add ui/tabs
Formatnya adalah namespace/block, dengan namespace yang cocok dengan kunci dalam konfigurasi registries Anda.
CLI:
- Mengambil data dari registry
- Menemukan blok
- Menyelesaikan dependensi (e.g.
tabsbergantung padatab-item) - Mengunduh semua file
- Menyimpannya ke direktori blok Anda
Jika blok hanya ada di satu registry, Anda dapat menghilangkan namespace:
npx blockstudio add tabs
Jika blok ada di beberapa registry, CLI meminta Anda memilih melalui terminal. Tanpa terminal, perintah berhenti dengan error yang mencantumkan registry yang cocok, dan --yes memilih registry pertama dalam urutan blocks.json.
Tambahkan beberapa blok
npx blockstudio add ui/tabs ui/hero ui/accordion
Semua blok diinstal dalam satu proses.
Pratinjau sebelum menginstal
npx blockstudio add ui/tabs --dry-run
Ini menampilkan apa yang akan diinstal tanpa menulis file apa pun.
Telusuri blok yang tersedia
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
list menampilkan semua blok dari semua registry (atau registry tertentu). search mencocokkan substring tanpa membedakan huruf besar-kecil pada nama, judul, dan deskripsi blok.
Hapus blok
npx blockstudio remove tabs
Ini menghapus folder blok. Dalam mode interaktif, Anda diminta mengonfirmasi. Berikan --yes untuk melewati prompt.
CI dan otomatisasi
init, add, dan remove menerima --yes untuk melewati prompt interaktif. list dan search tidak pernah menampilkan prompt dan menolak --yes sebagai opsi yang tidak dikenal. Saat stdin bukan terminal (runner CI, input berpipa), CLI beralih ke mode noninteraktif: init menimpa blocks.json yang sudah ada, add berhenti dengan error jika folder blok sudah ada atau nama blok ambigu, dan remove menghapus tanpa bertanya.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes