create-vg-start-template
v0.1.2
Published
Scaffold a WordPress + Vite + VG_Mailer theme from the vg-start-template repo.
Downloads
10
Maintainers
Readme
create-vg-start-template
Мини‑CLI для быстрого развёртывания темы на основе vg-start-template.
Usage
- Создать проект:
npx create-vg-start-template my-theme - Опции:
--repo <url>: Git URL репозитория шаблона (по умолчаниюhttps://github.com/<org>/vg-start-template.git)--pm <npm|pnpm|yarn>: менеджер пакетов (по умолчаниюnpm)--no-install: пропустить установку зависимостей--no-git: не инициализировать новый Git‑репозиторий- Переменная окружения:
VG_TEMPLATE_REPO— задаёт приватный URL по умолчанию - Доступ к приватному шаблону: требуется SSH‑доступ к GitHub‑репозиторию (например,
[email protected]:DenisChernykh/vg-start-template.git). Без доступа команда завершится ошибкой (контент не раскроется).
Что делает CLI
- Клонирует шаблон (git clone --depth=1; если git недоступен — через
npx degit) - Удаляет
.git, правитpackage.json:nameи заголовокstyle.css(Theme Name) - Запускает установку зависимостей (
npm install→ сработает postinstall с Composer) - Инициализирует новый Git‑репозиторий (можно отключить флагом)
Безопасность и приватность
- Сам CLI может быть публичным в npm — доступ к приватному шаблону ограничивается правами GitHub.
- Клонирование идёт по SSH. Если у пользователя нет доступа к приватному репозиторию, клонирование завершится ошибкой, содержимое не выдаётся.
- Для публичных репозиториев доступен деградационный режим
--allow-degit(по умолчанию выключен для приватности).
Публикация в npm
- В
packages/create-vg-start-template/package.jsonпроверьтеname. - Авторизуйтесь:
npm login - Опубликуйте:
npm publish --access public - Готово:
npx create-vg-start-template my-theme
Примечание
- Для приватного шаблона используйте SSH‑URL (
[email protected]:<org>/vg-start-template.git) или задайтеVG_TEMPLATE_REPO. - Все, кто запускает CLI, должны иметь доступ к приватному репозиторию (SSH ключ или GitHub login/token).
