시작하기
사전 요구 사항
- Node.js 18 이상
- 블록을 설치할 WordPress 테마 또는 플러그인
npm의 blockstudio 패키지는 버전 0.0.1입니다. 해당 릴리스는 자리표시자이며 Adding block: <name>을 출력하고 아무것도 가져오지 않은 채 종료하는 add 명령만 있습니다. 또한 init, list, search, remove, --yes 및 --dry-run을 알 수 없는 명령으로 거부합니다. 이 페이지의 명령은 Blockstudio 저장소(packages/registry)의 레지스트리 CLI을 설명합니다.
프로젝트 초기화
테마 또는 플러그인의 루트에서 init을 실행합니다:
npx blockstudio init
CLI이 대화형 설정을 안내합니다:
- 블록 디렉터리: 블록을 설치할 위치(기본값:
blockstudio) - 레지스트리: 이름을 지정해 레지스트리 URL을 하나 이상 추가합니다
blocks.json 파일을 생성합니다:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
대화형 질문을 건너뛸 수도 있습니다:
npx blockstudio init --yes
기본값이 설정된 blocks.json을 생성합니다. 나중에 직접 편집할 수 있습니다.
블록 추가
npx blockstudio add ui/tabs
형식은 namespace/block이며, namespace은 registries 구성의 키와 일치해야 합니다.
CLI의 작업:
- 레지스트리를 가져옵니다
- 블록을 찾습니다
- 종속성을 확인합니다(e.g.
tabs은tab-item에 종속됨) - 모든 파일을 다운로드합니다
- 블록 디렉터리에 파일을 기록합니다
블록이 하나의 레지스트리에만 있으면 네임스페이스를 생략할 수 있습니다:
npx blockstudio add tabs
여러 레지스트리에 있으면 터미널에서 CLI이 선택을 요청합니다. 터미널이 없으면 일치하는 레지스트리 목록을 표시하며 중단하고, --yes은 blocks.json 순서에서 첫 번째 레지스트리를 선택합니다.
여러 블록 추가
npx blockstudio add ui/tabs ui/hero ui/accordion
모든 블록을 한 번에 설치합니다.
설치 전 미리보기
npx blockstudio add ui/tabs --dry-run
파일을 쓰지 않고 설치될 항목을 확인합니다.
사용 가능한 블록 찾아보기
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
list은 모든 레지스트리 또는 특정 레지스트리의 모든 블록을 표시합니다. search은 블록 이름, 제목 및 설명을 대상으로 대소문자를 구분하지 않는 부분 문자열 검색을 수행합니다.
블록 삭제
npx blockstudio remove tabs
블록 폴더를 삭제합니다. 대화형 모드에서는 확인 메시지가 표시됩니다. --yes을 전달하면 확인을 건너뜁니다.
CI 및 자동화
init, add 및 remove는 대화형 확인 절차를 건너뛰는 --yes을 허용합니다.
list와 search는 확인을 표시하지 않으며 --yes을 알 수 없는 옵션으로 거부합니다.
stdin이 터미널이 아니면(CI 러너, 파이프 입력 등) CLI은 비대화형 모드로 전환합니다. init은 기존 blocks.json를 덮어쓰고, 블록 폴더가 이미 있거나 블록 이름이 모호하면 add은 오류와 함께 중단하며, remove은 확인 없이 삭제합니다.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes