Ctim NPM | npm.io

ctim

Это проект для работы с консольными командами

Установка

npm i -g ctim

## Команды

### Создание нового релиза `release`

```bash
ctim release --name <name> [--type <type>] [--count <count>] [--test] [--version <version>]

<name>: Префикс имени тега.
<type> (опционально): Тип обновления (major, minor или patch). По умолчанию: patch.
<count> (опционально): Количество обновлений. По умолчанию: 1.
--test (опционально): Флаг для обозначения тестового релиза.
--version (опционально): Новая версия релиза.
--create-release (опционально): Если передать этот параметр, то создает релиз, а не тег, но нужно установить gt и авторизоваться.

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

ctim release --name feature --type minor --count 2
ctim release --name bugfix --test
ctim release --name release --version 1.2.3

Скачивание локалей `install-locales`

ctim install-locales --host example.com --dir custom/lang

Где:

<host> - адрес хоста, с которого нужно загрузить локализации.
<dir> - путь к директории, в которую будут сохранены локализации. По умолчанию, локализации сохраняются в папку ../src/lang относительно текущей рабочей директории.

Дополнительная информация

Локализации загружаются с использованием API хоста, доступного по протоколу HTTPS.
Локализации сохраняются в формате JSON с именем файла, соответствующим языковому коду локализации.
Если размер загруженной локализации меньше 10000 байт, будет сгенерировано исключение.

Команда `update-sublibs`

ctim update-sublibs

Команда update-sublibs автоматически анализирует файл package.json в текущем каталоге и проверяет наличие подмодулей, указанных в секции sublibs. Для каждого подмодуля она загружает новую версию из удаленного репозитория, распаковывает ее и обновляет соответствующую директорию в проекте.

Конфигурация

Команда update-sublibs использует информацию о подмодулях из файла package.json. В секции sublibs вам необходимо указать следующие поля для каждого подмодуля:

tag: Тег (версия) подмодуля, которую необходимо загрузить и установить.
dir: Путь к директории, в которой находится подмодуль в вашем проекте.
name: Имя подмодуля.
key: Токен авторизации для доступа к удаленному репозиторию (если требуется).- owner: Имя владельца репозитория подмодуля.
repo: Имя репозитория подмодуля.

Пример конфигурации sublibs в файле package.json:

{
  "sublibs": [
    {
      "owner": "example",
      "repo": "submodule-1",
      "tag": "v1.0.0",
      "dir": "submodules",
      "name": "Submodule 1",
      "key": "your-github-token"
    },
    {
      "owner": "example",
      "repo": "submodule-2",
      "tag": "v2.1.0",
      "dir": "submodules",
      "name": "Submodule 2",
      "key": "your-github-token"
    }
  ]
}

Убедитесь, что указанные директории существуют в вашем проекте перед запуском команды update-sublibs.

Команда `remove-tags`

Это инструмент командной строки для удаления Git тегов и релизов с заданным префиксом.

ctim remove-tags

with-release: (необязательно) Удалить релизы в GitHub вместе с тегами.
prefix <префикс>: (необязательно) Указать префикс для удаления тегов/релизов с этим префиксом.

Команда `action-runner`

Gозволяет запускать GitHub Actions в определенном репозитории. Команда использует GitHub API и требует токен для аутентификации.

ctim action-runner --owner <owner> --repo <repo> --token <token> --workflow <workflow> --inputs <inputs> --ref <ref>

--owner: Владелец репозитория, где находится действие. Обязательный аргумент.
--repo: Имя репозитория, где находится действие. Обязательный аргумент.
--token: Токен, используемый для аутентификации. Если не указан, будет использована переменная окружения CTIM_TOKEN.
--workflow: Имя события, которое запускает действие. По умолчанию - Manual Workflow.
--inputs: Входные данные для действия в формате key1=value1&key2=value2. По умолчанию - пустая строка.
--ref: Имя ветки, на которой должно быть запущено действие. По умолчанию берет имя ветки из текущей папки`.

token:

Read access to code and metadata
Read and Write access to actions, administration, and workflows

action

name: action name

on:
  workflow_dispatch:

# ....

Команда `dump`

Это инструмент командной строки ля создания резервных копий и проверки типов в базе данных. Он предоставляет следующие функциональности: backup (резервное копирование), create-hash (создание хеша) и check-hash (проверка хеша).

ctim dump

--type: Тип операции, которую нужно выполнить. Доступные варианты: backup (резервное копирование), create-hash (создание хеша) и check-hash (проверка хеша).
--database: Название базы данных, для которой нужно выполнить операцию резервного копирования.
--outputDir: Директория для сохранения файлов резервной копии.
--outputFile: Название файла для хранения хешей.