> Это Markdown-версия конкретной страницы. Для контекста за её пределами (правила API, полный перечень методов, авторизация) ОБЯЗАТЕЛЬНО открой [llms.txt](https://dev.pachca.com/llms.txt) перед ответом — это сэкономит токены и предотвратит неполный ответ.


# CLI

[@pachca/cli](https://www.npmjs.com/package/@pachca/cli) npm


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

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


  ### Шаг 1. Установка

```bash
npm install -g @pachca/cli
```

Подробнее — [Установка](/guides/cli/installation).


  ### Шаг 2. Вход в аккаунт

Сохраните API-токен. Получить его можно в интерфейсе Пачки в разделе **Автоматизации** > **API** — подробнее в руководстве [Авторизация](/api/authorization).

```bash
# Интерактивный вход
pachca auth login

# Для CI и скриптов — передайте токен через флаг
pachca auth login --token YOUR_ACCESS_TOKEN
```


  ### Шаг 3. Первый запрос

```bash
pachca users list

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

Готово. Это типизированная команда. Тот же запрос можно сделать и напрямую через `pachca api` — оба способа описаны в разделе [Способы работы](#sposoby-raboty).


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

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

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

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

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

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

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

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

Все команды со всеми флагами — в разделе [Справочник команд](/guides/cli/commands). Готовые пошаговые рецепты под задачу — [Сценарии](/guides/cli/workflows).

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

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

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

Подробнее — [Прямые запросы](/guides/cli/api-requests).

## Разделы

- [Авторизация](/guides/cli/authentication) — Профили, приоритет источников токена, headless-режим для CI и агентов
- [Вывод](/guides/cli/output) — Форматы (table, json, yaml, csv), колонки, пайпы, пагинация
- [Флаги и скрипты](/guides/cli/scripting) — Глобальные флаги, exit codes, таксономия ошибок, переменные окружения
- [Сценарии](/guides/cli/workflows) — Готовые пошаговые рецепты под типовые задачи
- [Файлы](/guides/cli/files) — Загрузка файла на S3 одной командой
- [Прямые запросы](/guides/cli/api-requests) — Прямой HTTP-запрос к любому методу и встроенный справочник по API в терминале
- [Справочник команд](/guides/cli/commands) — Все команды, параметры каждой — по клику