Для разработчиков

Обзор

Официальный CLI для Pachca API: авторизация, сообщения, управление пространством — всё из терминала. Каждый метод API доступен как команда с типизированными флагами, валидацией и подсказками. Нужен Node.js 20+.

Быстрый старт

Установка

npm install -g @pachca/cli

Подробнее — Установка.

Вход в аккаунт

Если вход выполняете вы сами, достаточно подтвердить его в браузере — получать токен заранее не нужно. Для CI и агентов, где подтверждать некому, передайте готовый токен из раздела Автоматизации > API.

# Подтверждение в браузереpachca auth login # Готовым токеном — для CI и агентовecho "$PACHCA_TOKEN" | pachca auth login --token -

Подробнее — Авторизация в CLI.

Первый запрос

pachca users list # ID    Имя              Email               Роль# 1234  Иван Иванов      ivan@company.ru     admin# 5678  Мария Петрова    maria@company.ru    user

Готово. Это типизированная команда. Тот же запрос можно сделать и напрямую через pachca api — оба способа описаны в разделе Способы работы.

Без установки — разовый запуск через npx, токен передаётся флагом:

npx -y @pachca/cli users list --token YOUR_ACCESS_TOKEN

Способы работы

С CLI можно работать двумя способами. Основной — типизированные команды: так написаны все примеры в документации и интеграции. В дополнение есть команда pachca api для прямых запросов и встроенного справочника по API.

Типизированные команды

Каждый метод API — отдельная команда pachca <секция> <действие> с флагами, валидацией и подсказками. Справка по любой команде — флаг --help:

pachca messages create --entity-id 123 --content "Привет"  # отправить сообщениеpachca messages create --help  # справка по этой командеpachca commands  # список всех команд

Пропущенные обязательные флаги CLI запросит интерактивно. Флаг -o json переключает вывод в машиночитаемый JSON.

Все команды со всеми флагами — в разделе Справочник команд. Готовые пошаговые рецепты под задачу — Сценарии.

Прямые запросы

Команда pachca api отправляет прямой HTTP-запрос к любому методу — для нестандартных вызовов и отладки. Она же работает как встроенный справочник по API: список эндпоинтов и справку по каждому (параметры, тело, пример) можно получить прямо в терминале, не открывая сайт документации — особенно удобно агентам:

pachca api POST /messages -f message[entity_id]=123 -f message[content]="Привет"  # тот же запросpachca api POST /messages --describe  # справка по тому же методуpachca api ls  # список всех эндпоинтов

Подробнее — Прямые запросы.