Быстрый старт

Вариант 1: Интерактивный режим

Запустите генератор и следуйте подсказкам:

zgf

Подсказки включают:

• Имя проекта
• Менеджер пакетов
• Язык (TypeScript / JavaScript)
• Архитектура (FSD / Atomic / Empty)
• Маршрутизация (опционально с приватной зоной)
• Стейт‑менеджер (RTK / Mobx / None)

Вариант 2: Параметры CLI

Показать параметры CLI

Пример:

CLI example

zgf --name=my-app --pm=yarn --lang=ts --arch=fsd --routing --private --sm=redux

Параметр	Алиас	Тип	Описание
--name	-n	string	Имя проекта
--pm		string	Менеджер пакетов (npm, yarn, pnpm)
--lang		string	Язык (ts, js)
--arch		string	Архитектура (fsd, atomic, empty)
--routing		boolean	Включить react-router-dom
--private		boolean	Добавить публичную/приватную маршрутизацию
--sm		string	Стейт‑менеджер (redux, mobx, none)
--help		boolean	Показать справку
--version		boolean	Показать версию CLI
--preset		string	Создать проект по пресету
--preset-list		boolean	Показать список пресетов

---

CLI Help

Выполните команду, чтобы посмотреть все доступные опции CLI:

zgf --help

Чтобы проверить установленную версию:

zgf --version

Пример вывода:

Показать пример вывода

Параметры

Параметр	Алиас	Тип	Описание	Значения
--name	-n	string	Имя проекта	—
--pm		string	Менеджер пакетов	npm · yarn · pnpm
--lang		string	Язык программирования	ts · js
--arch		string	Тип архитектуры	fsd · atomic · empty
--routing		boolean	Включить react-router-dom	—
--private		boolean	Добавить публичные/приватные маршруты	—
--sm		string	Стейт‑менеджер	redux · mobx · none
--help		boolean	Показать справку	—
--version		boolean	Показать версию CLI	—
--preset		string	Создать проект по пресету	—
--preset-list		boolean	Показать список пресетов	—

Примеры

CLI example

zgf --name=my-app --pm=yarn --lang=ts --arch=fsd --routing --private --sm=redux

примечание

Создайте свой пресет для более быстрой инициализации:

zgf-preset

Внимание! Для корректной работы пресетов и других функций CLI необходимо установить глобально — см. раздел Установка.

---

Рецепты

• [FSD + TypeScript + routing]

  CLI example

  zgf --name=my-app --pm=yarn --lang=ts --arch=fsd --routing --private --sm=redux

• [Минимальный пустой JS‑проект]

  zgf --name=playground --pm=npm --lang=js --arch=empty --sm=none

• [Использовать пресет]

  zgf --preset=my-preset

🧰 Устранение неполадок

• "zgf: command not found" — установите глобально:

  npm i -g zero-guess-frontend

• Windows: cannot run scripts — разрешите выполнение скриптов в PowerShell:

  Set-ExecutionPolicy -Scope CurrentUser RemoteSigned

• EACCES / права доступа — убедитесь, что у вас есть права на запись в целевую папку.

---

Смотрите также

• Установка: installation
• FAQ: faq