add README.md

2025-12-10 13:10:47 +03:00
parent 100c5512f4
commit 060768563d
4 changed files with 204 additions and 1 deletions
--- a/README.ru.md
+++ b/README.ru.md
@@ -0,0 +1,99 @@
+# dm-cli
+
+CLI клиент для apostol-dm - интерфейс командной строки для доступа к функциям модуля сделок BitDeals.
+
+## Описание
+
+`dm-cli` предоставляет командную строку для работы с модулем сделок (apostol-dm) сервиса обработки bitcoin платежей BitDeals. Приложение поддерживает все основные функции модуля сделок через удобный интерфейс командной строки.
+
+## Сборка
+```bash
+cd dm-cli/dm-cli
+make
+```
+
+```bash
+mv dm-cli /usr/local/bin/
+```
+
+## Использование
+
+### Общий синтаксис
+
+```bash
+Использование: dm-cli [глобальные параметры] <группа> [<аргументы>]
+
+Глобальные параметры:
+  --bitdeals           адрес BitDeals сервера
+  --debug              выводить отладочную информацию, входные и выходные API-запросы
+  --address <ip:port>  адрес модуля сделок (dm), по умолчанию: 127.0.0.1:4999
+  --help               вывести краткую справку по всем подкомандам
+  --version            вывести строку версии
+
+    dm-cli account status <биткоин адрес>
+        Показать учётные данные аккаунта
+    dm-cli account update [параметры]
+        Изменить учётные данные аккаунта
+
+    dm-cli deal create
+        Создать новую сделку
+    dm-cli deal status
+        Показать данные сделки
+    dm-cli deal complete
+        Завершить сделку
+    dm-cli deal cancel
+        Отменить сделку
+    dm-cli deal negative
+        Оставить негативный отзыв
+```
+
+### Отладочный режим
+
+В отладочном режиме выводятся curl запросы и ответы к apostol-dm API.
+
+```bash
+dm-cli --debug account status 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa
+```
+
+### Локализация
+
+Приложение автоматически определяет язык на основе переменной окружения `LANG`:
+
+```bash
+# Русский язык
+export LANG=ru_RU.UTF-8
+dm-cli --help
+
+# Английский язык (по умолчанию)
+export LANG=en_US.UTF-8
+dm-cli --help
+```
+
+## Примеры использования
+
+### Создание сделки
+
+```bash
+dm-cli deal create \
+    --at "https://testnet-dm.bitdeals.org" \
+    --seller miuwWQrUc6EFWiUBTi2rMyiEaJSeacn2zo \
+    --customer mraXx7JrmAmuKypdJ1vseQBXySsdRZE5AC \
+    --type prepayment \
+    --sum 0.0052 \
+    --pay 2025-09-20 \
+    --leave-before 2025-10-03
+```
+
+### Проверка статуса сделки
+
+```bash
+dm-cli deal status 6e90c7d6ef823e41257cbcc16cd2e318fd578970
+```
+
+### Проверка оплаты сделки
+
+```bash
+dm-cli deal status --is-paid 6e90c7d6ef823e41257cbcc16cd2e318fd578970
+echo $?  # 0 если оплачена, 1 если нет
+```
+