@weavix/cli 0.1.0-dev

package/README.md

@@ -0,0 +1,94 @@
+# @weavix/cli
+
+CLI-инструмент для работы с плагинами.
+
+## Установка
+
+Установите пакет глобально:
+
+```bash
+npm install -g @weavix/cli
+```
+
+## Конфигурация
+
+Перед первым использованием задайте параметры подключения (S3-хранилище, URL API):
+
+```bash
+weavix config set
+```
+
+Другие команды для работы с конфигурацией:
+
+```bash
+weavix config show    # показать текущую конфигурацию
+weavix config clear   # удалить конфигурацию
+```
+
+## Быстрый старт
+
+### 1. Создание плагина
+
+```bash
+weavix create
+```
+
+Вам будет предложено:
+
+- Выбрать шаблон
+- Ввести данные плагина (название, описание и т.д.)
+- Настроить структуру проекта
+
+### 2. Отладка
+
+Запустите локальный сервер разработки с hot reload:
+
+```bash
+weavix debug
+```
+
+Ищите плагин в слоте, прописанном в `manifest.json`.
+
+### 3. Развертывание
+
+Соберите и загрузите плагин:
+
+```bash
+weavix deploy
+```
+
+### 4. Установка
+
+Зарегистрируйте плагин в конфиге окружения:
+
+```bash
+weavix install
+```
+
+## Доступные команды
+
+### Конфигурация
+
+- **`config set`** — задать параметры CLI (S3 endpoints, buckets, URL API)
+- **`config show`** — показать текущую конфигурацию
+- **`config clear`** — удалить конфигурацию
+
+### Аутентификация
+
+- **`login`** — сохранить OAuth-токен
+- **`logout`** — удалить сохранённые учётные данные
+- **`whoami`** — показать текущего пользователя
+
+### Разработка
+
+- **`create`** — создать новый плагин из шаблона
+- **`build`** — собрать плагин для продакшена
+- **`lint`** — запустить TypeScript и ESLint
+- **`debug`** — запустить локальный сервер разработки
+- **`debug --no-lint`** — то же, без валидации манифеста
+
+### Развертывание
+
+- **`deploy`** — собрать и загрузить плагин в S3
+- **`install`** — зарегистрировать плагин в конфиге окружения
+- **`uninstall`** — удалить плагин из всех слотов