Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/s00d/ctim

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/s00d/ctim
Owner: s00d
License: mit
Created: 2023-08-29T07:01:28.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-11-30T18:07:17.000Z (about 1 year ago)
Last Synced: 2024-11-09T03:05:51.027Z (about 2 months ago)
Language: TypeScript
Size: 322 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md
- License: LICENSE

Awesome Lists containing this project

README

# ctim

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

## Установка

```bash
npm i -g ctim

## Команды

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

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

- ``: Префикс имени тега.
- `` (опционально): Тип обновления (major, minor или patch). По умолчанию: patch.
- `` (опционально): Количество обновлений. По умолчанию: 1.
- `--test` (опционально): Флаг для обозначения тестового релиза.
- `--version` (опционально): Новая версия релиза.
- `--create-release` (опционально): Если передать этот параметр, то создает релиз, а не тег, но нужно установить [gt](https://cli.github.com/) и авторизоваться.

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

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

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

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

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

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

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

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

```shell
ctim update-sublibs
```

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

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

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

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

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

```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 тегов и релизов с заданным префиксом.

```shell
ctim remove-tags
```

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

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

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

```shell
ctim action-runner --owner --repo --token --workflow --inputs --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`

![1](https://raw.githubusercontent.com/s00d/ctim/main/assets/1.jpeg)
![2](https://raw.githubusercontent.com/s00d/ctim/main/assets/2.jpeg)
![3](https://raw.githubusercontent.com/s00d/ctim/main/assets/3.jpeg)
![4](https://raw.githubusercontent.com/s00d/ctim/main/assets/4.jpeg)

#### action

```yaml
name: action name

on:
workflow_dispatch:

# ....
```

### Команда `dump`

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

```shell
ctim dump
```

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

## Лицензия

Этот проект распространяется под лицензией MIT. См. файл `LICENSE` для дополнительной информации.

## Лицензия

Этот проект лицензирован под MIT License. См. файл [LICENSE](./LICENSE) для получения дополнительной информации.
```