CLI утилита umbot

Описание

CLI утилита umbot предназначена для быстрого создания и настройки новых проектов на базе umbot. Утилита позволяет:

• Создавать новые проекты по шаблонам
• Настраивать конфигурацию проекта
• Генерировать базовую структуру приложения

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

Базовый синтаксис

npx umbot <команда> [параметры]
Copy

Доступные команды

Команда	Описание	Параметры
create	Создание нового проекта	<project-name> или <config-file.json>
generateEnv	Сгенерировать файл .env	-

Флаги

Флаг	Описание
--minimal	Создаёт минимальный рабочий проект (1 файл, без контроллера и конфигов). Подходит для быстрого старта или демонстрации. Работает только с типом default.
--prod	Создаёт production-готовый проект с Dockerfile, .github/workflows/deploy.yml, .env.

💡 Важно: флаг --minimal не применяется к типу quiz, так как викторина требует сложной логики и хранения состояния. Для quiz всегда генерируется полная структура.

Создание проекта

Простое создание

Для быстрого создания приложения, выполните следующую команду

npx umbot create my-bot-project
Copy

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

npm i
npm run build
npm start
Copy

Создание с конфигурацией

Для быстрого создания приложения с дополнительными настройками, выполните следующую команду

npx umbot create config.json
Copy

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

npm i
npm run build
npm start
Copy

Конфигурация проекта

Структура конфигурационного файла

interface ProjectConfig {
    // Название проекта (обязательное поле)
    name: string;

    // Тип проекта: "default" или "quiz"
    type?: 'default' | 'quiz';

    // Режим работы: "prod", "dev", "dev-online", "build"
    mode?: 'prod' | 'dev' | 'dev-online' | 'build';

    // Конфигурация базы данных
    config?: DatabaseConfig[];

    // Параметры приложения
    params?: AppParams[];

    // Путь для создания проекта
    path?: string;

    // Имя хоста на котором будет запущено приложение. По умолчанию localhost
    hostname?: string;
    // Порт на котором будет запущено приложение. По умолчанию 3000
    port?: string;
    // Определяет нужно создавать .env файл или нет
    isEnv?: boolean;
}
Copy

Пример конфигурационного файла

{
    "name": "my-quiz-bot",
    "type": "quiz",
    "mode": "dev",
    "path": "./bots/quiz",
    "config": {
        "json": "./data",
        "error_log": "./logs",
        "isLocalStorage": true,
        "db": {
            "host": "",
            "user": "",
            "pass": "",
            "database": ""
        },
        "tokens": {
            "alisa": {
                "token": "token"
            }
        }
    },
    "isEnv": true
}
Copy

Типы проектов

Тип	Описание	Особенности
default	Базовый шаблон	Минимальная структура проекта
quiz	Шаблон викторины	Готовая структура для создания викторин

Режимы работы

Режим	Описание
prod	Продакшн режим
dev	Режим разработки
dev-online	Режим разработки с онлайн обновлением
build	Режим сборки

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

Создание простого бота

umbot create simple-bot
Copy

Создание викторины

{
    "name": "quiz-bot",
    "type": "quiz",
    "mode": "dev",
    "config": {
        "json": "./data",
        "error_log": "./logs",
        "isLocalStorage": true
    }
}
Copy

umbot create quiz-config.json
Copy

Лучшие практики

1. Именование проектов:

   • Используйте понятные имена
   • Избегайте пробелов и специальных символов
   • Придерживайтесь kebab-case

2. Конфигурация:

   • Храните конфигурацию в отдельных файлах
   • Не включайте чувствительные данные в репозиторий
   • Используйте разные конфигурации для разных окружений

3. Структура проекта:

   • Следуйте рекомендуемой структуре
   • Размещайте файлы в соответствующих директориях
   • Документируйте нестандартные решения