Skip to content

The open alternative to Salesforce, designed for AI.

12.1 KB
Raw Blame
---
title: CLI
description: Войдите в рабочее пространство, изучайте его данные и создавайте приложения из терминала с помощью Twenty CLI.
---

import { PageBanner } from "/snippets/page-banner.mdx"

## Запуск CLI

CLI `twenty` подключается к рабочим пространствам Twenty из вашего терминала. Используйте его для проверки метаданных, чтения записей, отправки API-запросов, а также создания, синхронизации и отладки приложений. Требуется **Node.js 24.5+ или 26.5+**.

Запускайте любую команду через `npx` без установки чего-либо:

```bash filename="Terminal"
npx twenty@latest --version
```

Или один раз установите его глобально и вызывайте `twenty` напрямую:

```bash filename="Terminal"
npm install -g twenty
twenty --version
```

В примерах ниже используется `twenty`. Добавьте перед ними `npx twenty@latest`, если вы не устанавливали его глобально. Выполните `twenty commands`, чтобы получить полный список команд, и `twenty \<command> --help`, чтобы получить параметры отдельной команды.

| Команда       | Что делает                                                                                 |
| ------------- | ------------------------------------------------------------------------------------------ |
| `авторизация` | Войти, проверить и удалить учётные данные                                                  |
| `remote`      | Просмотр, выбор, переименование и удаление сохранённых подключений к рабочему пространству |
| `метаданные`  | Просматривайте объекты и поля                                                              |
| `data`        | Просматривайте и читайте записи                                                            |
| `api`         | Отправляйте необработанные REST- или GraphQL-запросы                                       |
| `открыть`     | Откройте рабочее пространство в браузере                                                   |
| `приложение`  | Создавайте, собирайте, синхронизируйте, отлаживайте и удаляйте приложения                  |
| `локальный`   | Сначал, проверить, остановить, обновить и сбросить локальную среду развития                |
| `doctor`      | Диагностируйте CLI, SDK приложения и подключение к рабочему пространству                   |

Каждая команда, взаимодействующая с рабочим пространством, принимает `--remote \<name>` для выбора сохранённого подключения вместо подключения по умолчанию и `--json` для структурированного вывода.

## Подключение к рабочему пространству

Войдите через браузер. `--use` делает это подключение подключением по умолчанию:

```bash filename="Terminal"
twenty auth login --url https://acme.twenty.com --use
twenty auth status
```

Используйте адрес своего рабочего пространства или адрес сервера для локальной установки: `http://localhost:2020` для [локальной среды разработки](/ru/developers/extend/apps/getting-started/local-server), `http://localhost:3000` для исходной версии из репозитория. Точную команду можно скопировать в разделе **Settings > Developers > CLI**. Для входа через браузер требуется Twenty 2.42 или более поздняя версия.

Сохраните несколько подключений, присвоив им имена:

```bash filename="Terminal"
twenty auth login --url http://localhost:2020 --name local
twenty remote list
twenty remote use local
```

В CI или скриптах передайте API-ключ через канал вместо входа через браузер:

```bash filename="Terminal"
printf '%s' "$TWENTY_API_KEY" | twenty auth login --with-token --url https://acme.twenty.com --name ci
```

Также можно задать `TWENTY_API_URL` и `TWENTY_API_KEY` для одного запуска, ничего не сохраняя. Сохранённые подключения хранятся в `~/.twenty/config.json`.

## Изучение данных

```bash filename="Terminal"
# Objects and fields
twenty metadata object list
twenty metadata field list companies

# Records
twenty data list companies --limit 5
twenty data list companies --filter 'employees[gte]:5000' --order-by 'employees[DescNullsLast]'
twenty data get people <id>

# Raw API requests
twenty api rest '/rest/companies?limit=5'
twenty api graphql --query '{ companies(first: 2) { edges { node { name } } } }'

# Open the workspace, or a page inside it
twenty open
twenty open settings/developers
```

Имена объектов должны точно соответствовать именам API и могут быть в единственном или множественном числе (`company` или `companies`). Необработанные записи через API выполняются без подтверждения, при этом по-прежнему действуют ваши разрешения в рабочем пространстве.

## Сборка приложения

```bash filename="Terminal"
npx twenty@latest app init my-app
cd my-app
yarn install
npx twenty@latest app apply --create
npx twenty@latest app dev
```

* `app init` создаёт новый проект из шаблона. Она не устанавливает зависимости и не подключается к рабочему пространству.
* `app apply --create` собирает приложение, регистрирует его в рабочем пространстве, устанавливает и синхронизирует его метаданные.
* `app dev` отслеживает исходный код и синхронизирует каждую успешную сборку.

Другие команды приложения:

| Команда                       | Что делает                                                                 |
| ----------------------------- | -------------------------------------------------------------------------- |
| `app add`                     | Создайте заготовку объекта, поля, логической функции или другой сущности   |
| `app build` / `app typecheck` | Соберите приложение или проверьте типы локально                            |
| `app plan`                    | Предварительно просмотрите изменения метаданных, которые внесёт применение |
| `app apply`                   | Соберите, загрузите и синхронизируйте приложение                           |
| `app generate-client`         | Повторно сгенерируйте типизированный API-клиент без синхронизации          |
| `app pull`                    | Восстановить метаданные, переводы и сохранённые зависимости                |
| `app translations extract`    | Извлечь переводимые строки в каталоги `locales/`                           |
| `app publish`                 | Опубликуйте приложение в npm или в частном реестре Twenty                  |
| `app install`                 | Установите в рабочее пространство уже зарегистрированный пакет приложения  |
| `app uninstall`               | Удалите из рабочего пространства приложение и всё, чем оно владеет         |

Определения, отсутствующие в исходном коде, по умолчанию удаляются из рабочего пространства. Передайте `--no-prune`, чтобы сохранить их. Пользовательское приложение рабочей области сохраняет их, если не передать `--prune`. Удаление объектов или полей также удаляет их данные, поэтому требуется подтверждение. Подробнее см. в разделе [Синхронизация и восстановление](/ru/developers/extend/apps/operations/sync-and-recovery).

## Выполнение функций

Запустите развёрнутую логическую функцию, не вызывая её через маршрут, cron или событие базы данных. Сначала синхронизируйте локальные изменения с помощью `app apply` или `app dev`.

```bash filename="Terminal"
twenty app exec --name create-new-post-card
twenty app exec --name create-new-post-card --payload '{"name": "Hello"}'

# Install and uninstall hooks
twenty app exec --post-install
twenty app exec --pre-install
twenty app exec --uninstall-hook
```

Для выполнения функций требуется вход через браузер. API-ключи не могут их выполнять.

## Просмотр журналов функций

Передавайте поток вывода логических функций приложения по мере завершения выполнений:

```bash filename="Terminal"
twenty app logs
twenty app logs --name create-new-post-card
```

Отображаются только новые выполнения, а не прошлые.

## Удаление приложения

```bash filename="Terminal"
twenty app uninstall
twenty app uninstall --yes
```

Будет выполнен хук удаления приложения и удалено всё, чем оно владеет, включая его объекты, поля и их данные. Приложение останется зарегистрированным, поэтому `twenty app apply` сможет установить его снова.

## Диагностика проблем

```bash filename="Terminal"
twenty doctor
twenty doctor --offline
```

`doctor` проверяет версию Node, какой бинарный файл `twenty` находится в `PATH`, сохранённые подключения и SDK приложения, а затем сообщает, что нужно исправить.

## Скрипты и тесты

Вывод сборки относится к CLI. Не считывайте `.twenty/output/manifest.json` и не импортируйте внутренний код сборки; считывайте `data.manifest` из `twenty app build --json`.

## Полный справочник

[Справочник команд](https://github.com/twentyhq/twenty/blob/main/packages/twenty-cli/docs/commands.md) содержит описание всех флагов, разрешений, форматов вывода и кодов завершения.

<PageBanner illustration="card-page-cli" />