Создатель модуля
Справочник команд CLI модуля
Точные команды, принятые параметры, переменные среды и коды завершения процесса для @fabledgg/module-cli 0.1.x.
Команды
| Команда | Цель |
|---|---|
| fabled module init [directory] | Создайте новый каркас Dice & Chat; каталог по умолчанию fabled-dice-chat |
| fabled module validate [directory] | Проверьте исходный проект; текущий каталог по умолчанию |
| fabled module pack [directory] | Проверка и создание детерминированного ZIP-файла |
| fabled module inspect <archive.zip> | Безопасно проверить существующий архив и сообщить о нем |
| fabled module login | Считать URI/код сопряжения через скрытый ввод или stdin; сохранить непрозрачный сеанс на 8 часов без продления |
| fabled module logout | Отозвать действующий сеанс CLI, затем удалить локальные учётные данные; сохранить файл для повторной попытки при неудачном отзыве |
| fabled module publisher claim [directory] | Укажите пространство имен издателя в манифесте. |
| fabled module publisher status | Показать текущие полномочия пространства имен |
| fabled module publish [archive.zip|directory] | Упакуйте, если необходимо, и отправьте релиз на рассмотрение. |
| fabled module submissions | Список материалов, принадлежащих авторам |
| fabled module status $SUBMISSION_ID | Показать одну заявку или дождаться решения |
Опции
| Опция | Применяется к / границам |
|---|---|
| --json | Каждая команда; один машиночитаемый результат |
| --token-stdin | Издатель, публикация, материалы, статус; токен из стандартного ввода |
| -h, --help | Справка по корневой команде или модулю |
| --publisher-id, --publisher-name, --module-id, --name | инициализировать поля идентификации/отображения scaffold |
| --output <path> | вывод пакета; default dist/<id>-<version>.zip |
| --channel prerelease|stable | опубликовать; предварительная версия по умолчанию |
| --request-id <id> | издатель заявляет права и публикует; 1–128 символов безопасного идентификатора. |
| --status <status> | материалы; без учета регистра PENDING, CHANGES_REQUESTED, REJECTED, APPROVED, WITHDRAWN |
| --package <publisher.module> | фильтр пакета материалов |
| --page <number> | материалы; отсчет от нуля, по умолчанию 0 |
| --size <number> | материалы; 1–100, по умолчанию 25 |
| --wait | статус; опрос до тех пор, пока рассмотрение не примет окончательное решение |
| --timeout <seconds> | статус --wait; 1–1800, по умолчанию 600 |
| --interval <seconds> | статус --wait; 1–30, по умолчанию 5 |
Переменные среды
| Переменная | Поведение |
|---|---|
| FABLED_API_URL | Корень API публикации; по умолчанию https://api.fabled.gg; HTTPS, кроме HTTP с обратной связью |
| FABLED_WEB_URL | Origin браузера для входа; HTTPS или loopback HTTP; задайте для собственных origin API |
| FABLED_CREDENTIALS_PATH | Абсолютное переопределение для сохраненного файла учетных данных |
| FABLED_ACCESS_TOKEN | Токен доступа к автоматизации; переопределяет сохраненный логин |
Коды выхода
| Код | Значение |
|---|---|
| 0 | Успех |
| 2 | Ошибка использования команды |
| 3 | Ошибка проверки модуля |
| 4 | Ошибка ввода-вывода файловой системы |
| 5 | Небезопасный или некорректный архив |
| 6 | Ошибка аутентификации |
| 7 | Сбой сети |
| 8 | Сбой или конфликт службы публикации |
| 10 | Непредвиденная внутренняя ошибка |