Запуск CLI
CLItwenty подключается к рабочим пространствам 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 или более поздняя версия.
Сохраните несколько подключений, присвоив им имена:
TWENTY_API_URL и TWENTY_API_KEY для одного запуска, ничего не сохраняя. Сохранённые подключения хранятся в ~/.twenty/config.json.
Изучение данных
company или companies). Необработанные записи через API выполняются без подтверждения, при этом по-прежнему действуют ваши разрешения в рабочем пространстве.
Сборка приложения
app initсоздаёт новый проект из шаблона. Она не устанавливает зависимости и не подключается к рабочему пространству.app apply --createсобирает приложение, регистрирует его в рабочем пространстве, устанавливает и синхронизирует его метаданные.app devотслеживает исходный код и синхронизирует каждую успешную сборку.
Определения, отсутствующие в исходном коде, по умолчанию удаляются из рабочего пространства. Передайте
--no-prune, чтобы сохранить их. Пользовательское приложение рабочей области сохраняет их, если не передать --prune. Удаление объектов или полей также удаляет их данные, поэтому требуется подтверждение. Подробнее см. в разделе Синхронизация и восстановление.
Выполнение функций
Запустите развёрнутую логическую функцию, не вызывая её через маршрут, cron или событие базы данных. Сначала синхронизируйте локальные изменения с помощьюapp apply или app dev.
Просмотр журналов функций
Передавайте поток вывода логических функций приложения по мере завершения выполнений:Удаление приложения
twenty app apply сможет установить его снова.
Диагностика проблем
doctor проверяет версию Node, какой бинарный файл twenty находится в PATH, сохранённые подключения и SDK приложения, а затем сообщает, что нужно исправить.
Скрипты и тесты
Вывод сборки относится к CLI. Не считывайте.twenty/output/manifest.json и не импортируйте внутренний код сборки; считывайте data.manifest из twenty app build --json.