---
metadata:
  - name: generator
    content: Diplodoc Platform v5.63.0
  - property: og:type
    content: article
  - property: article:section
    content: Платформа плагинов
  - property: og:title
    content: CLI
  - property: article:tag
    content: Техническая инструкция
alternate:
  - https://www.yandex.ru/support/tracker/en/plugins/tools/cli.md
  - https://www.yandex.ru/support/tracker/ru/plugins/tools/cli.md
  - href: https://www.yandex.ru/support/tracker/ru/plugins/tools/cli.md
    type: text/markdown
    title: Markdown version
  - href: https://www.yandex.ru/support/tracker/ru/llms.txt
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://www.yandex.ru/support/tracker/ru/llms.txt


# CLI

CLI — это консольная утилита в виде NPM пакета, которая обеспечивает весь жизненный цикл плагина: создание, отладка, проверка и публикация.

## Доступные команды {#commands}

#|
|| **Команда** | **Описание** ||
|| `create` | Создать плагин из шаблона ||
|| `up` | Обновить плагин до актуальной версии шаблона ||
|| `build` | Собрать плагин ||
|| `build-docs` | Собрать документацию плагина ||
|| `debug` | Запустить локальную отладку плагина ||
|| `lint` | Проверить манифест, TypeScript, ESLint и стили ||
|| `version` | Посмотреть или изменить версию плагина в `manifest.json` ||
|| `upgrade` | Обновить CLI до последней версии ||
|| `login` | Войти в аккаунт и сохранить токен ||
|| `logout` | Выйти из аккаунта и удалить сохраненный токен ||
|| `doctor` | Проверить локальный проект, авторизацию и конфигурацию CLI ||
|| `submit [--public]` | Проверить, собрать и отправить плагин на модерацию. Для нового публичного плагина использовать флаг `--public` ||
|| `list` | Посмотреть список своих плагинов и статусы модерации ||
|| `info [plugin-id]` | Посмотреть информацию о плагине, замечания модератора и последнюю заявку на публикацию. Если идентификатор не указан, CLI возьмет его из манифеста ||
|| `make-public [plugin-id]` | Сделать плагин публичным. Для плагина, опубликованного в организации, создать заявку на модерацию Яндекса ||
|| `withdraw [plugin-id] [version]` | Отозвать отправленную на модерацию версию или выполнить `withdraw --publication [plugin-id]`, чтобы отозвать активную заявку на публикацию. Если аргументы не указаны, CLI возьмет их из манифеста ||
|| `manifest` | Изменить поля манифеста `manifest.json` ||
|#

Чтобы посмотреть встроенную справку, выполните команду `weavix --help`. Для справки по конкретной команде добавьте после нее флаг `--help`, например `weavix submit --help`.

## Установка {#install}

```bash
npm install -g @weavix/cli 
```

## Локальная разработка {#debug}

1. Сначала включите в интерфейсе Трекера режим отладки плагинов

    ```
    Настройки - Эксперименты - Отладка плагинов
    ```

    При включении отладки браузер может запросить разрешение на доступ сайта к локальной сети. Разрешите доступ: без него отладка не будет работать, так как конфиг и плагины загружаются с `localhost`.

2. Затем запустите режим отладки в папке плагина:

    ```bash
    weavix debug
    ```

3. Откройте в интерфейсе Трекера используемую в плагине точку интеграции.

4. Вносите изменения в код интерфейса плагина — они сразу применяются в интерфейсе.

## Публикация плагина {#publish}

Публикация выполняется в следующем порядке:

1. Получите токен для CLI:

    ```bash
    weavix login
    ```

2. Перед публикацией убедитесь, что в проекте есть обязательные файлы для каталога:

    - `public/logo.svg`
    - `marketplace/header-image.jpg`
    - `marketplace/index.md`

3. Запустите полный процесс публикации:

    ```bash
    weavix submit
    ```

    Команда сама выполнит регистрацию плагина при необходимости, загрузку дистрибутива и отправку версии на модерацию.

    {% note info "" %}

    Если CLI сообщает, что установленная версия больше не поддерживается, обновите его:

    ```bash
    weavix upgrade
    ```

    Если команда недоступна, переустановите последнюю версию: `npm i -g @weavix/cli@latest`.

    {% endnote %}

    Если плагин еще не опубликован, его можно сразу сделать публичным и отправить версию на модерацию Яндекса:

    ```bash
    weavix submit --public
    ```

    CLI зарегистрирует плагин, переключит его видимость на `PUBLIC` и отправит версию на модерацию. Если плагин уже публичный, отправляйте новые версии командой `weavix submit` без флага `--public`. Публичный плагин нельзя снова сделать доступным только своей организации.

    Если плагин уже опубликован в каталоге организации, используйте другую команду:

    ```bash
    weavix make-public
    ```

    Команда создаст заявку на публикацию последней версии, одобренной организацией. CLI попросит подтвердить необратимое изменение видимости. Чтобы пропустить подтверждение, используйте флаг `--yes`; при запуске без терминала этот флаг обязателен.

    Пока заявка находится на модерации, отправлять новые версии нельзя. Проверить статус заявки и комментарий модератора можно командой:

    ```bash
    weavix info
    ```

    Перед использованием команд публичной публикации ознакомьтесь с [требованиями к карточке плагина и проверкой на секреты](https://www.yandex.ru/support/tracker/ru/plugins/publish.md#public-requirements).

4. После отправки на модерацию проверяйте статус публикации:

    ```bash
    weavix list
    ```

    Чтобы посмотреть замечания модератора к версии плагина и последнюю заявку на публикацию, выполните команду:

    ```bash
    weavix info
    ```

    Для заявки команда покажет идентификатор и статус заявки, идентификатор версии, даты подачи и решения, а также комментарий модератора. В выводе `weavix list` не отображаются комментарии модератора и данные заявки.

## Отзыв версии с модерации {#withdraw}

Отозвать можно только версию со статусом `IN_REVIEW`. Выполните команду:

```bash
weavix withdraw
```

CLI возьмет значения `id` и `version` из файла `manifest.json` текущего проекта. Чтобы отозвать другую версию, укажите идентификатор плагина и номер версии:

```bash
weavix withdraw <plugin-id> <version>
```

Чтобы отозвать активную заявку на публикацию плагина в публичном каталоге, выполните команду:

```bash
weavix withdraw --publication
```

CLI возьмет идентификатор плагина из `manifest.json`. Чтобы передать идентификатор другого плагина, выполните команду:

```bash
weavix withdraw --publication <plugin-id>
```

После отзыва заявки снова можно отправлять версии.

## Редактирование манифеста {#manifest}

Команда `manifest` изменяет поля файла `manifest.json`. Путь до поля указывается в точечной нотации, например `author.name`.

#|
|| **Команда** | **Описание** ||
|| `manifest set <path> <value>` | Установить значение поля манифеста по пути, например `author.name` ||
|| `manifest add <path> <value>` | Добавить элемент в массив по пути. Если массив отсутствует, CLI создаст его ||
|| `manifest remove <path> <value>` | Удалить подходящий элемент из массива по пути ||
|| `manifest unset <path>` | Удалить поле по пути ||
|| `manifest edit` | Выбрать и изменить поле манифеста в интерактивном режиме ||
|#