CLI
Справочник команд
Паттерн всех команд: pachca [секция] [действие] [--флаги]
Имена команд совпадают с URL документации:
Глобальные флаги (доступны для всех команд) и переменные окружения — в разделе Флаги и скрипты.
Все команды
Раскройте строку, чтобы увидеть параметры команды. Обязательные аргументы и флаги помечены *.
| Команда | Метод API |
|---|---|
pachca api | Произвольный запрос к API. Список и справка: `api ls` (список эндпоинтов), `api <МЕТОД> <путь> --describe` / `--spec` / `--docs` |
pachca auth list | Список сохранённых профилей |
pachca auth login | Авторизация и сохранение токена |
pachca auth logout | Удаление сохранённого профиля |
pachca auth status | Статус текущего профиля |
pachca auth switch | Переключение активного профиля |
pachca bots list-events | GETИстория событий |
pachca bots remove-event | DELETEУдаление события |
pachca bots update | PUTРедактирование бота |
pachca changelog | История изменений CLI |
pachca chats archive | PUTАрхивация чата |
pachca chats create | POSTНовый чат |
pachca chats get | GETИнформация о чате |
pachca chats list | GETСписок чатов |
pachca chats unarchive | PUTРазархивация чата |
pachca chats update | PUTОбновление чата |
pachca commands | Список всех команд |
pachca common custom-properties | GETСписок дополнительных полей |
pachca common direct-url | POSTЗагрузка файла |
pachca common get-exports | GETСкачать архив экспорта |
pachca common request-export | POSTЭкспорт сообщений |
pachca common uploads | POSTПолучение подписи, ключа и других параметров |
pachca config get | Получение значения конфигурации |
pachca config list | Список всех настроек |
pachca config set | Установка значения конфигурации |
pachca doctor | Диагностика окружения: Node.js, сеть, токен, конфигурация |
pachca group-tags create | POSTНовый тег |
pachca group-tags delete | DELETEУдаление тега |
pachca group-tags get | GETИнформация о теге |
pachca group-tags list | GETСписок тегов сотрудников |
pachca group-tags list-users | GETСписок сотрудников тега |
pachca group-tags update | PUTРедактирование тега |
pachca guide | Поиск сценариев использования |
pachca introspect | Метаданные команды в машиночитаемом формате |
pachca link-previews add | POSTUnfurl (разворачивание ссылок) |
pachca members add | POSTДобавление пользователей |
pachca members add-group-tags | POSTДобавление тегов |
pachca members leave | DELETEВыход из беседы или канала |
pachca members list | GETСписок участников чата |
pachca members remove | DELETEИсключение пользователя |
pachca members remove-group-tag | DELETEИсключение тега |
pachca members update | PUTРедактирование роли |
pachca messages create | POSTНовое сообщение |
pachca messages delete | DELETEУдаление сообщения |
pachca messages get | GETИнформация о сообщении |
pachca messages list | GETСписок сообщений чата |
pachca messages pin | POSTЗакрепление сообщения |
pachca messages unpin | DELETEОткрепление сообщения |
pachca messages update | PUTРедактирование сообщения |
pachca profile delete-avatar | DELETEУдаление аватара |
pachca profile delete-status | DELETEУдаление статуса |
pachca profile get | GETИнформация о профиле |
pachca profile get-info | GETИнформация о токене |
pachca profile get-status | GETТекущий статус |
pachca profile update-avatar | PUTЗагрузка аватара |
pachca profile update-status | PUTНовый статус |
pachca reactions add | POSTДобавление реакции |
pachca reactions list | GETСписок реакций |
pachca reactions remove | DELETEУдаление реакции |
pachca read-member list-readers | GETСписок прочитавших сообщение |
pachca search list-chats | GETПоиск чатов |
pachca search list-messages | GETПоиск сообщений |
pachca search list-users | GETПоиск сотрудников |
pachca security list | GETЖурнал аудита событий |
pachca tasks create | POSTНовое напоминание |
pachca tasks delete | DELETEУдаление напоминания |
pachca tasks get | GETИнформация о напоминании |
pachca tasks list | GETСписок напоминаний |
pachca tasks update | PUTРедактирование напоминания |
pachca threads add | POSTНовый тред |
pachca threads get | GETИнформация о треде |
pachca threads list | GETСписок тредов |
pachca upgrade | Обновить CLI до последней версии |
pachca upload | Загрузить файл (получает подпись и загружает автоматически) |
pachca users create | POSTСоздать сотрудника |
pachca users delete | DELETEУдаление сотрудника |
pachca users get | GETИнформация о сотруднике |
pachca users get-status | GETСтатус сотрудника |
pachca users list | GETСписок сотрудников |
pachca users remove-avatar | DELETEУдаление аватара сотрудника |
pachca users remove-status | DELETEУдаление статуса сотрудника |
pachca users update | PUTРедактирование сотрудника |
pachca users update-avatar | PUTЗагрузка аватара сотрудника |
pachca users update-status | PUTНовый статус сотрудника |
pachca version | Версия CLI |
pachca views open | POSTОткрытие представления |
Справка
Не знаете точный эндпоинт — посмотрите список и справку прямо в CLI: pachca api ls, затем pachca api <МЕТОД> <путь> --describe. Подробнее — в разделе Прямые запросы.