Перейти к основному содержанию

Запуск CLI

CLI twenty подключается к рабочим пространствам Twenty из вашего терминала. Используйте его для проверки метаданных, чтения записей, отправки API-запросов, а также создания, синхронизации и отладки приложений. Требуется Node.js 24.5+ или 26.5+. Запускайте любую команду через npx без установки чего-либо:
Или один раз установите его глобально и вызывайте twenty напрямую:
В примерах ниже используется twenty. Добавьте перед ними npx twenty@latest, если вы не устанавливали его глобально. Выполните twenty commands, чтобы получить полный список команд, и twenty \<command> --help, чтобы получить параметры отдельной команды. Каждая команда, взаимодействующая с рабочим пространством, принимает --remote \<name> для выбора сохранённого подключения вместо подключения по умолчанию и --json для структурированного вывода.

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

Войдите через браузер. --use делает это подключение подключением по умолчанию:
Используйте адрес своего рабочего пространства или адрес сервера для локальной установки: http://localhost:2020 для локальной среды разработки, http://localhost:3000 для исходной версии из репозитория. Точную команду можно скопировать в разделе Settings > Developers > CLI. Для входа через браузер требуется Twenty 2.42 или более поздняя версия. Сохраните несколько подключений, присвоив им имена:
В CI или скриптах передайте API-ключ через канал вместо входа через браузер:
Также можно задать TWENTY_API_URL и TWENTY_API_KEY для одного запуска, ничего не сохраняя. Сохранённые подключения хранятся в ~/.twenty/config.json.

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

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

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

  • app init создаёт новый проект из шаблона. Она не устанавливает зависимости и не подключается к рабочему пространству.
  • app apply --create собирает приложение, регистрирует его в рабочем пространстве, устанавливает и синхронизирует его метаданные.
  • app dev отслеживает исходный код и синхронизирует каждую успешную сборку.
Другие команды приложения: Определения, отсутствующие в исходном коде, по умолчанию удаляются из рабочего пространства. Передайте --no-prune, чтобы сохранить их. Пользовательское приложение рабочей области сохраняет их, если не передать --prune. Удаление объектов или полей также удаляет их данные, поэтому требуется подтверждение. Подробнее см. в разделе Синхронизация и восстановление.

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

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

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

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

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

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

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

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

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

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

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

Справочник команд содержит описание всех флагов, разрешений, форматов вывода и кодов завершения.