@pachca/cli
v2026.3.10
Published
CLI для Pachca API
Downloads
1,258
Readme
@pachca/cli
Официальный CLI для Пачки.
Установка
npm install -g @pachca/cli
# Или без установки:
npx @pachca/cli users listБыстрый старт
pachca auth login # сохранить токен
pachca users list # список сотрудников
pachca messages create --entity-id 123 --content "Привет!"Получить токен: https://dev.pachca.com/guides/authorization
Использование в агентах (Claude, Cursor и др.)
Если агент устанавливает CLI по просьбе пользователя и токена ещё нет — агент должен запросить его у пользователя:
# Агент спрашивает: "Нужен API-токен Пачки."
# "Получите его на https://dev.pachca.com/guides/authorization"
pachca auth login --token <токен от пользователя>
# Дальше команды работают без токена в каждой строке
pachca users list
pachca messages create --entity-id 123 --content "Привет!"Если токен уже есть в окружении — auth login не нужен:
PACHCA_TOKEN=$TOKEN pachca users listПрофили (несколько токенов)
Храните несколько токенов под именами — личный, боты:
pachca auth login --profile personal
pachca auth login --profile bot-notify
pachca auth list
pachca auth switch bot-notifyТокены хранятся в ~/.config/pachca/config.toml (chmod 600).
В CI — через переменную окружения PACHCA_TOKEN.
Поиск по сценариям
Не знаете какую команду использовать? Поищите по задаче:
pachca guide "отправить файл"
pachca guide "создать беседу и добавить участников"
pachca guide # список всех сценариевЗагрузка файлов
# Загрузить файл (получает подпись и загружает автоматически)
pachca upload photo.jpg
# Из stdin
cat data.csv | pachca upload -Команда upload автоматически получает подпись (POST /uploads) и загружает файл на S3. Возвращает key — используйте его в --files при создании сообщений.
Пагинация
# Первая страница (по умолчанию)
pachca users list --limit 20
# Следующая страница вручную
pachca users list --cursor eyJpZCI6NTB9
# Загрузить все страницы автоматически
pachca users list --allИмена флагов
Флаги CLI используют kebab-case (через дефис), а не snake_case как в API-документации — это стандартная конвенция всех современных CLI:
API-документация CLI-флаг
first_name → --first-name
phone_number → --phone-number
entity_id → --entity-id
skip_email_notify → --skip-email-notify
list_tags → --list-tags
custom_properties → --custom-propertiesПри отправке запроса CLI автоматически конвертирует имена обратно в snake_case для API.
Вывод и скрипты
# JSON вместо таблицы
pachca users list -o json
# YAML
pachca users list -o yaml
# CSV (для Excel / Google Sheets)
pachca users list -o csv
# Выбрать колонки
pachca users list --columns id,email,role
# Только значения без заголовка (для скриптов)
pachca users list --columns email --no-header
# Пайп — цвет отключается автоматически
pachca users list -o json | jq '.[].name'
# Текст из файла или pipe
pachca messages create --entity-id 123 < message.txt
echo "Деплой завершён" | pachca messages create --entity-id 123
# Скачать файл (для команд с редиректом)
pachca common get-exports 123 --save ./export.zip
# Посмотреть запрос без отправки
pachca messages create --entity-id 123 --content "Привет" --dry-run
# Тихий режим — только exit code, без вывода
pachca messages create -q --entity-id 123 --content "Деплой завершён"
# CI / неинтерактивный режим
PACHCA_TOKEN=xxx pachca messages create --entity-id 123 --content "Деплой завершён" --no-input
# DELETE без подтверждения (в TTY)
pachca users delete 1234 --force
# Boolean-флаги: --flag (true), --no-flag (false)
pachca users update 123 --suspended
pachca users update 123 --no-suspended
pachca chats update 123 --no-publicПрямые API-запросы
Escape hatch для нестандартных запросов без сгенерированных команд:
pachca api GET /messages --query chat_id=123
pachca api POST /messages -F message[chat_id]=12345 -f message[content]="Привет"
pachca api POST /messages --input payload.json
pachca api GET /profile -o yaml --dry-runНастройки
Установить постоянные дефолты:
pachca config set defaults.output json # всегда JSON
pachca config set defaults.timeout 60 # таймаут 60s
pachca config list # все настройкиДиагностика
pachca doctorДоступные команды
pachca commands --availableChangelog
pachca changelogShell completion
pachca autocomplete zsh # zsh completion
pachca autocomplete bash # bash completion
pachca autocomplete fish # fish completionПеременные окружения
| Переменная | Описание |
|-----------|---------|
| PACHCA_TOKEN | Bearer-токен (высший приоритет, удобно для CI) |
| PACHCA_PROFILE | Активный профиль для команды |
| PACHCA_TIMEOUT | Таймаут запроса в секундах (по умолчанию 30) |
| PACHCA_PROMPT_DISABLED | Отключить интерактивные промпты |
| CI | Стандартная переменная CI-окружений |
| NO_COLOR | Отключить цвет в выводе |
| FORCE_COLOR | Принудительно включить цвет |
| PACHCA_SKIP_NEW_VERSION_CHECK | Отключить проверку обновлений |
Документация API
Полная документация: https://dev.pachca.com
