nb plugin import

Импортирует упакованный архив плагина или npm-пакет в storage/plugins. Команда только помещает плагин в целевой каталог и не включает его автоматически.

Использование

nb plugin import <archive> [flags]

Параметры

ПараметрТипОписание
<archive>stringИсточник плагина; обязательный параметр. Поддерживаются локальный путь .tgz, удалённый URL архива http(s) или имя npm-пакета / тег
--env, -estringИмя CLI-окружения; если не указано, обычно используется текущее окружение. Если явно передан --storage-path, --env можно не указывать
--yes, -ybooleanЕсли явно переданный --env указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение
--storage-pathstringПереопределяет корневой путь целевого хранилища; фактический каталог импорта — <storage-path>/plugins
--npm-registrystringУказывает реестр npm, который нужно использовать, если источник — имя или тег npm-пакета

Примеры

# Удалённый архив
nb plugin import https://github.com/nocobase/plugin-auth-cas/releases/download/v1.4.0/plugin-auth-cas-1.4.0.tgz

# Локальный архив
nb plugin import /your/path/plugin-auth-cas-1.4.0.tgz

# npm-пакет или тег
nb plugin import @my-scope/plugin-auth-cas@beta

# Приватный реестр npm
nb plugin import @my-scope/plugin-auth-cas@beta --npm-registry=https://registry.example.com

# Запись напрямую в локальный путь хранилища без привязки к текущему окружению
nb plugin import ./plugin-auth-cas-1.4.0.tgz --storage-path ./storage

Примечания

Если целевое окружение уже выбрано, путь по умолчанию — storage/plugins этого окружения.

Если нужно только записать плагин в локальный каталог хранилища, передайте --storage-path. В этом случае --env можно опустить, и CLI запишет файлы напрямую в <storage-path>/plugins.

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

  • при первой установке сначала выполните nb app restart, а затем nb plugin enable;
  • если вы только повторно импортировали более новый архив, сначала перезапустите приложение, а затем проверьте, что новая версия загрузилась.

Если источник находится в приватном реестре npm, сначала выполните вход, а затем импортируйте пакет:

npm login --registry=https://registry.example.com
nb plugin import @my-scope/plugin-auth-cas@beta --npm-registry=https://registry.example.com
Примечание

Вручную распаковывать что-либо в storage/plugins не нужно: nb plugin import автоматически поместит плагин в правильный каталог.

Связанные команды