Команда входа Intlayer CLI

Описание

Команда login Intlayer CLI позволяет аутентифицироваться в Intlayer CMS. Эта команда автоматически открывает ваш браузер по умолчанию, чтобы завершить процесс аутентификации и получить необходимые учетные данные (Client ID и Client Secret) для использования сервисов Intlayer.

Использование

npx intlayer login [options]

или

intlayer login [options]

Параметры

--cms-url <url>

Укажите URL Intlayer CMS, к которой нужно подключиться для аутентификации.

• Тип: string
• По умолчанию: Значение, настроенное в intlayer.config.* или https://intlayer.org
• Пример:

npx intlayer login --cms-url https://intlayer.org

Параметры конфигурации

Вы также можете использовать общие параметры конфигурации:

• --env-file <path>: Путь к файлу окружения
• -e, --env <env>: Среда выполнения
• --base-dir <dir>: Базовая директория проекта
• --verbose: Включить подробный вывод (по умолчанию: true)
• --prefix <prefix>: Префикс для логов

Как это работает

1. Запуск локального сервера: команда запускает локальный HTTP-сервер на случайном порту для получения учетных данных от CMS
2. Открытие браузера: команда автоматически открывает ваш браузер по умолчанию на URL входа в CMS
3. Аутентификация: завершите аутентификацию в браузере, используя вашу учетную запись Intlayer
4. Получение учетных данных: локальный сервер получает Client ID и Client Secret от CMS
5. Инструкции: команда отображает инструкции по настройке учетных данных в вашем проекте

Вывод

После успешного входа команда выведет:

1. Полученные учетные данные (Client ID и Client Secret)
2. Инструкции для файла .env:

INTLAYER_CLIENT_ID=your_client_id
INTLAYER_CLIENT_SECRET=your_client_secret

3. Инструкции для конфигурационного файла Intlayer:

{
  editor: {
    cmsURL: 'https://intlayer.org',
    clientId: process.env.INTLAYER_CLIENT_ID,
    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
  },
}

Безопасность ключа доступа

intlayer login выдает ключ доступа: пару clientId / clientSecret, которую используют все аутентифицированные команды (push, pull, fill, configuration push, live, …) для аутентификации.

import type { IntlayerConfig } from "intlayer";

const config: IntlayerConfig = {
  editor: {
    clientId: process.env.INTLAYER_CLIENT_ID,
    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
  },
};

export default config;

clientSecret — это учетные данные на стороне сервера. Он предоставляет полный доступ к API в области проекта — чтение и запись ваших словарей, вашего проекта и вашей организации. Сохраняйте его в .env (игнорируется git) или в хранилище секретов CI, и никогда не встраивайте его непосредственно в файл конфигурации.

Intlayer это обеспечивает, а не только документирует:

• clientSecret удаляется из конфигурации, которую встраивает ваш bundler, поэтому он не может попасть в bundle браузера, независимо от того, какую интеграцию framework вы используете. Он читается только на стороне сервера, во время выполнения, из окружения.
• clientId отличается: это открытый ключ проекта, безопасный для распространения и используемый @intlayer/analytics для получения краткосрочного токена только для приема.

Достаточно закомментировать clientId, чтобы отключить все аутентифицированное поведение — получение удаленных словарей, доступ к CMS, аналитику — даже если переменные окружения все еще определены.

Для CI pipelines предпочитайте ci команду, которая внедряет учетные данные на время одного запуска вместо их сохранения.

Ручная настройка

Если браузер не откроется автоматически, вы можете вручную перейти по URL, отображаемому в терминале.

Примеры

Вход с указанием пользовательского URL CMS

npx intlayer login --cms-url https://custom-cms.example.com

Вход с указанием файла окружения

npx intlayer login --env-file .env.production

Вход в verbose-режиме

npx intlayer login --verbose

Устранение неполадок

Браузер не открылся

Если браузер не откроется автоматически, скопируйте URL, показанный в терминале, и откройте его вручную в браузере.

Проблемы с подключением

Если возникают проблемы с подключением, проверьте:

1. Что URL CMS указан корректно
2. Что ваше интернет-соединение работает корректно
3. Что брандмауэры не блокируют соединение

Учетные данные не получены

Если учетные данные не получены:

1. Убедитесь, что вы завершили процесс аутентификации в браузере
2. Проверьте, что локальный порт не заблокирован
3. Повторите команду

Следующие шаги

После завершения входа:

1. Добавьте учетные данные в файл .env
2. Настройте файл intlayer.config.*, указав учетные данные
3. Используйте команды CLI для управления словарями:
   • npx intlayer push - Отправить словари в CMS
   • npx intlayer pull - Получить словари из CMS
   • npx intlayer fill - Заполнить отсутствующие переводы

См. также

• Документация CLI
• Конфигурация Intlayer
• Intlayer CMS