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


# CLI

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

[**@weavix/cli** на npmjs.com](https://www.npmjs.com/package/@weavix/cli)

Для установки выполните команду:

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

Наличие шаблона для определенного сервиса в CLI не гарантирует, что плагин можно встроить в этот сервис: шаблон лишь позволяет создать проект и запустить его локально. Будут ли доступны слоты в самом сервисе, зависит от версии релиза и его настроек.


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

| **Команда**   | **Описание**                                                            |
|---------------|-------------------------------------------------------------------------|
| `create`      | Создать плагин из шаблона                                               |
| `up`          | Обновить плагин со старой версии шаблона                                |
| `build`       | Собрать плагин                                                          |
| `build-docs`  | Собрать справку плагина с помощью [Diplodoc](https://diplodoc.com/docs/ru)                              |
| `debug`       | Запустить локальную отладку плагина                                     |
| `lint`        | Запустить проверки TypeScript и ESLint                                  |
| `version`     | Показать или изменить версию плагина в `manifest.json`                  |
| `manifest`    | Изменить поля манифеста `manifest.json`                                 |
| `login`       | Войти в аккаунт                                                         |
| `logout`      | Удалить сохраненные данные авторизации                                  |
| `doctor`      | Проверить проект, авторизацию и конфигурацию                            |
| `submit`      | Зарегистрировать плагин, загрузить дистрибутив и отправить на модерацию |
| `list`        | Посмотреть список своих зарегистрированных плагинов                     |
| `info`        | Посмотреть подробную информацию о плагине                               |
| `withdraw`    | Отозвать отправленную версию с модерации                                |
| `help`        | Вывести справку по командам CLI                                         |


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

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

```bash
weavix debug
```

2. Откройте сервис, в котором будете проверять плагин:

  - для Трекера, Вики и Форм откройте интерфейс сервиса — параметр `slotPluginsConfigUrl` не нужен;
  - для Календаря, Диска и Почты откройте URL, который напечатал CLI. URL соответствует сервису из `manifest.json` и может содержать `slotPluginsConfigUrl=http://localhost:5173/config.json`.

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

4. Откройте сервис и найдите место встраивания плагина в интерфейс сервиса.

5. Вносите изменения в код плагина `src/App.tsx` — изменения видны сразу, без перезапусков.

{% note warning "" %}

Браузер Safari не поддерживает режим отладки, используйте другой браузер.

Если отладка не работает, обратитесь к администратору вашей организации и попросите разрешить отладку плагинов. [Как разрешить отладку](https://yandex.ru/support/yandex-360/business/admin/)

{% endnote %}

## Редактирование манифеста {#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`                       | Выбрать и изменить поле манифеста в интерактивном режиме                                         |

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

Чтобы опубликовать плагин, сделайте следующее:

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

    ```bash
    weavix login
    ```

2. Запустите публикацию:

    ```bash
    weavix submit
    ```

    CLI зарегистрирует плагин на платформе, загрузит дистрибутив и отправит плагин на модерацию.

3. Проверьте статус публикации:

    ```bash
    weavix list
    ```

[Подробнее о публикации плагина](https://yandex.ru/dev/yandex-360/extensions/ru/publish.md) 
