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


# CLI

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

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

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

Чтобы посмотреть встроенную справку, выполните команду `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
    ```

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

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

    ```bash
    weavix list
    ```

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

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

```bash
weavix withdraw
```

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

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