001k-cli

001k-cli

English · Русский · Українська

CLI-інструмент та AI-агентський скіл для 001k.bot — депозити, виведення, свопи, перекази, лімітні ордери та AML-перевірки.

• 🌐 Сайт: https://001k.bot
• 📖 Документація API: https://docs.001k.bot
• 💬 Telegram: @OO1kBOT

⚠️ Застереження. 001k-cli — офіційний інструмент 001k, який виконує реальні фінансові операції (депозити, виведення, свопи, перекази). Надається «ЯК Є», без жодних гарантій (див. LICENSE). Використовуйте на власний ризик; це не є фінансовою порадою. Завжди перевіряйте команди, що змінюють стан, перед виконанням.

---

Можливості

• Повне покриття API — депозити, виведення, свопи, перекази, лімітні ордери, AML-перевірки, баланс і журнал операцій.
• Вбудований AI-агентський скіл — скіл (001k-cli) керує CLI з Claude Code та будь-якого агента природною мовою.
• Безпека за замовчуванням — підпис запитів HMAC-SHA256; секретний ключ використовується лише локально й ніколи не передається та не логується.
• Кілька профілів — іменовані профілі в ~/.001k/ (глобально) або ./.001k/ (проєкт), обираються через --profile.
• Лише HTTPS — CLI не надішле облікові дані протоколом, відмінним від https://.
• JSON-вивід — структурований JSON у stdout із зрозумілими кодами виходу (0/1/2/3) — спрямовуйте у jq чи будь-яку автоматизацію.
• Готовий до CI/CD — облікові дані через змінні OO1K_ACCESS_KEY / OO1K_SECRET_KEY для неінтерактивних пайплайнів.

---

Швидкий старт

# 1. Встановити CLI глобально
npm install -g 001k-cli
# або іншим менеджером пакетів:
# pnpm add -g 001k-cli  |  yarn global add 001k-cli  |  bun add -g 001k-cli

# 2. Авторизуватися (інтерактивне введення ключа доступу та секретного ключа)
001k auth login

# 3. (Опційно) Встановити AI-агентський скіл для Claude Code
npx skills add OO1kBOT/001k-cli

Як це працює

Проєкт складається з двох шарів:

1. CLI (001k) — самостійний інструмент командного рядка, який підписує запити HMAC-SHA256, звертається до API 001k.bot і повертає структурований JSON.
2. Скіл (001k-cli) — набір інструкцій, що навчає AI-агента (наприклад, Claude Code), коли і як викликати CLI. Агент читає скіл, інтерпретує запити природною мовою та перетворює їх на команди 001k.

Усі секрети залишаються локально. CLI підписує запити вашими HMAC-ключами; ані скіл, ані агент ніколи не бачать вихідних облікових даних.

---

Команди

Формат: 001k <сутність> <дія> [--прапорець значення]

Авторизація

Загальні

Депозит

Виведення

Своп

Переказ

Лімітний ордер

AML

Службові

Глобальні прапорці: --profile <ім'я>, --profile-path <файл>, --help, --version.

---

Авторизація

# Інтерактивний вхід — запитує ключ доступу та секретний ключ
001k auth login

# Іменований профіль / область проєкту
001k auth login --profile staging
001k auth login --scope project

Облікові дані визначаються в такому порядку (перемагає перший збіг):

1. --profile <ім'я>
2. --profile-path <файл>
3. Автовибір, якщо існує рівно один профіль
4. Помилка, якщо профілів декілька (вкажіть --profile)
5. Змінні середовища OO1K_ACCESS_KEY / OO1K_SECRET_KEY (для CI/CD)

Профілі зберігаються у форматі JSON з правами лише для власника:

• Глобально: ~/.001k/profiles/<ім'я>.json
• Проєкт: ./.001k/profiles/<ім'я>.json (перевизначає глобальний профіль з тим самим ім'ям)

Ключі зберігаються у відкритому вигляді (файли 0600). Не синхронізуйте ~/.001k/ з хмарними резервними копіями та використовуйте ключі з мінімальними правами. Див. SECURITY.md.

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

Для локального використання надавайте перевагу 001k auth login. Базовий URL має використовувати HTTPS (localhost — виняток для тестування).

---

Використання з AI-агентами

Скіл працює з будь-яким AI-агентом, що може виконувати команди оболонки — Claude Code, Cursor, Windsurf, Codex та іншими. Після встановлення агент перетворює природну мову на виклики CLI.

--direction для свопу — це code з 001k swap directions (не назва пари). --token для AML — числовий id з 001k aml token.

Налаштування з Claude Code

npx skills add встановлює скіл для Claude Code. Інші агенти можуть використовувати той самий скіл — вкажіть їм на skills/001k-cli/SKILL.md та додайте його в контекст агента; команди CLI ідентичні.

# 1. Переконайтеся, що CLI встановлено та авторизовано
001k auth status

# 2. Встановіть скіл
npx skills add OO1kBOT/001k-cli

# 3. Запустіть Claude Code і запитуйте
claude
> Покажи мій баланс і останні свопи

---

Розробка

Потрібен Node.js >= 24.

npm ci                  # встановити залежності
npm run build           # збірка у dist/
npm run dev -- status   # запуск з вихідного коду через tsx
npm run typecheck       # tsc --noEmit (src + tests)
npm test                # запустити тести
npm run test:coverage

Див. CONTRIBUTING.md.

Усунення несправностей

• No profile found. / No credentials found — виконайте 001k auth login або задайте OO1K_ACCESS_KEY / OO1K_SECRET_KEY. Перевірте через 001k auth status.
• ECONNREFUSED / ENOTFOUND / ETIMEDOUT — перевірте з'єднання та доступність OO1K_BASE_URL (за замовчуванням https://api.001k.world). Мережеві збої завершуються з кодом 3 і виводять { "network_error": true, "message": "..." } у stderr.
• Помилка небезпечного base URL — OO1K_BASE_URL має використовувати https:// (localhost — виняток).
• Версія Node — CLI потребує Node.js 24+ (node --version).

Помилки API повертаються у структурованому JSON з кодом і повідомленням. Використовуйте --help для перегляду прапорців.

Безпека

Повідомляйте про вразливості приватно — див. SECURITY.md. Ніколи не вставляйте API-ключі в issues.

Ліцензія

Apache-2.0 © 001k bot