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

Первый запуск

При первом запуске CLI проведет тебя через процесс настройки.

Автоматическая настройка

Просто запусти:

trisigma

Если CLI не настроен, появится предложение запустить настройку. Введи y и нажми Enter. CLI автоматически запустит процесс настройки.

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

Или запусти настройку явно:

trisigma init

init_success.png

Шаг 1: Настройка репозитория метрик

CLI предложит три способа подключения к репозиторию: использовать текущую директорию, указать путь вручную или клонировать репозиторий.

Вариант 1: Текущая директория (рекомендуется)

Если ты уже находишься в директории репозитория:

cd ~/projects/ab-metrics  # перейди в репозиторий
trisigma init
# Выбери вариант 1 \{#vyberi-variant-1}

CLI автоматически определит что текущая директория. валидный репозиторий метрик.

Вариант 2: Указать путь вручную

Если репозиторий находится в другой директории, введи полный путь. CLI проверит что по указанному пути находится валидный репозиторий.

Вариант 3: Клонировать репозиторий

Если у тебя еще нет локальной копии, введи URL репозитория. CLI выполнит git clone и настроит путь автоматически.

URL для клонирования ab-metrics:

git@github.com:<your-company>/<your-company>_ab_metrics.git ab-metrics

Проверка репозитория

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

Шаг 2: Авторизация в Trisigma

CLI попросит указать Backend URL. Введи адрес вашего API, например https://<your-company>-conf.trisigma.io.

OAuth авторизация

CLI откроет браузер для авторизации. Процесс:

  1. CLI запускает локальный HTTP-сервер на localhost:8080 (или другом свободном порту)
  2. Открывает браузер со страницей авторизации Trisigma
  3. После входа в систему, Trisigma перенаправляет браузер обратно на localhost с токеном
  4. CLI получает токен и сохраняет его в конфигурацию

oauth_success.png

!!! tip "Если браузер не открылся автоматически" Скопируй URL из терминала и открой его вручную в браузере. После авторизации CLI автоматически получит токен.

Шаг 3: Проверка конфигурации

init_success.png

CLI автоматически проверит подключение к API и покажет что токен валиден. Поздравляем! CLI готов к работе

Просмотр текущей конфигурации

Чтобы посмотреть текущие настройки:

trisigma config --show

Команда покажет все настройки: путь к репозиторию, API URL, backend URL и токен (частично скрыт для безопасности).

Обновление конфигурации

Обновление токена авторизации

Если токен истек или нужно переавторизоваться:

trisigma login

Процесс аналогичен первоначальной авторизации: CLI откроет браузер для OAuth.

Изменение пути к репозиторию

Если нужно подключиться к другому репозиторию:

trisigma init

Пройди процесс настройки заново. Старые настройки будут перезаписаны.

Структура конфигурации

CLI хранит настройки в домашней директории пользователя:

~/.trisigma/
├── config.json # Основная конфигурация
└── cache/ # Кеш результатов валидации

Права доступа:

  1. Директория ~/.trisigma/ имеет права 0700 (только владелец может читать/писать)
  2. Файл config.json имеет права 0600 (только владелец может читать)

Это обеспечивает безопасность хранения токена авторизации.

Первая проверка работоспособности

После настройки выполни простую проверку:

trisigma sl validate

CLI подключится к API и выполнит валидацию репозитория. Если увидишь сообщение об успешной валидации. всё работает!

Решение проблем при настройке

Проблема: Директория не является валидным репозиторием

Симптом:

Ошибка: Директория не является валидным репозиторием метрик

Причины:

  1. Неполная структура репозитория (отсутствуют обязательные директории)
  2. Указан неправильный путь
  3. Репозиторий не склонирован

Решение:

  1. Проверь структуру репозитория:

    cd ~/projects/ab-metrics
    ls -la

    Должны быть директории: sources/, dimensions/, metrics/, enrichments/, m42/, ab/

  2. Если структура неполная. выполни git pull для обновления

  3. Если репозиторий не склонирован. клонируй его:

    git clone git@github.com:&lt;your-company&gt;/&lt;your-company&gt;_ab_metrics.git ab-metrics

Проблема: Браузер не открывается при авторизации

Симптом: При запуске trisigma init браузер не открывается автоматически.

Решение:

  1. Скопируй URL из терминала:

    🌐 Откроется браузер: https://&lt;your-company&gt;-conf.trisigma.io/oauth/authorize?...
  2. Открой URL вручную в браузере

  3. Авторизуйся

  4. CLI автоматически получит токен

Проблема: Ошибка подключения к API

Симптом:

Ошибка: Не удалось подключиться к API

Причины:

  1. Нет сетевого доступа к https://&lt;your-company&gt;-conf.trisigma.io
  2. API временно недоступен

Решение:

  1. Проверь сетевой доступ:

    curl -s -o /dev/null -w "%{http_code}" https://&lt;your-company&gt;-conf.trisigma.io/_info | grep -q "200" && echo -e "\n\n\nAPI доступен и готов к работе" || echo -e "\n\n\nAPI недоступен"
  2. Проверь доступ к интернету

  3. Если API недоступен. попробуй позже или обратись в поддержку

Что дальше?

CLI настроен и готов к работе! Переходи к руководству по использованию:

Работа с Trisigma CLI | Назад к содержанию