CLI Трекера

Используйте CLI ytracker, чтобы работать с задачами Трекера из терминала.

Установить CLI и войти в Трекер

ytracker — консольная утилита для работы с Трекером. С ее помощью можно создавать и открывать задачи, работать с комментариями, вложениями и чеклистами, менять статус и искать задачи из терминала.

Чтобы установить CLI Трекера в macOS или Linux с glibc, выполните команду:

curl -fsSL https://storage.yandexcloud.net/ytracker-cli/install.sh | sh

Установщик добавит каталог утилиты в переменную PATH в файле настроек оболочки. Откройте новое окно терминала и проверьте установку:

ytracker --version --json

Чтобы установить CLI Трекера в Windows x64, выполните команду в PowerShell:

irm https://storage.yandexcloud.net/ytracker-cli/install.ps1 | iex
ytracker --version --json

Установщик проверяет контрольную сумму загруженного файла. В macOS и Linux утилита устанавливается в каталог ~/.local/bin. В Windows установщик добавляет каталог утилиты в пользовательскую переменную Path. Чтобы обновить CLI, повторите команду установки.

Установщик настраивает PATH для оболочек bash, zsh и sh. Для других оболочек, например fish, выполните установку командой curl -fsSL https://storage.yandexcloud.net/ytracker-cli/install.sh | sh -s -- --no-modify-path и добавьте каталог ~/.local/bin в PATH самостоятельно.

Для входа понадобится идентификатор организации. Его можно скопировать на странице Администрирование → Организации. Если у вас нет доступа к этой странице, запросите идентификатор у администратора организации.

Выполните команду и подтвердите вход на странице, которую откроет утилита:

ytracker auth login --method browser --organization-id <organization_id>

Если браузер нельзя открыть на этом компьютере, например при работе по SSH, или вы входите федеративным аккаунтом, укажите --method token вместо --method browser. Утилита выведет ссылку на страницу получения OAuth-токена и попросит вставить OAuth- или IAM-токен. Если вы входите федеративным аккаунтом, вставьте IAM-токен.

Чтобы проверить авторизацию, выполните команду:

ytracker whoami --json

Работать с задачами и API в CLI

С помощью CLI можно просматривать, искать, создавать и изменять задачи. Например:

  • просмотреть задачу вместе с комментариями, вложениями и чеклистом — ytracker TEAM-42;
  • найти задачу по ключу или названию — ytracker issue search --text "форма логина";
  • создать задачу — ytracker issue create --summary "Добавить проверку" --queue TEAM --type task;
  • изменить задачу — ytracker issue update TEAM-42 --priority critical --assignee <login>;
  • посмотреть доступные переходы между статусами — ytracker issue transition list TEAM-42;
  • изменить статус — ytracker issue transition execute TEAM-42 <transition_id>;
  • добавить комментарий — ytracker issue comment add TEAM-42 "Проверка добавлена".

Чтобы посмотреть группы команд, выполните ytracker --help. Для справки по группе команд укажите ее название, например ytracker issue --help.

Команды для работы с задачами подходят для автоматизации и не задают интерактивных вопросов. При перенаправлении вывода утилита возвращает валидный JSON в стандартный поток вывода, а диагностические сообщения — в стандартный поток ошибок. Чтобы выполнять команды без интерактивного входа, например в CI, передайте OAuth-токен в переменной окружения TRACKER_TOKEN или IAM-токен в TRACKER_IAM_TOKEN, а идентификатор организации — в TRACKER_ORGANIZATION_ID.

Чтобы проверить команду перед изменением данных, добавьте к ней параметр --dry-run. Утилита выведет план HTTP-запросов и не отправит их.

Значения по умолчанию для новых задач можно хранить в файле .tracker.toml в текущем каталоге или в любом родительском, например в корне репозитория. Строка version = 1 в файле обязательна:

version = 1

[create]
queue = "TEAM"
type = "task"

По умолчанию CLI проверяет в настройках очереди опцию Доступ для AI инструментов. Если выбрано значение Запретить, CLI не показывает и не изменяет задачи этой очереди, даже если они доступны вам в веб-интерфейсе. При этом CLI может создавать задачи в этой очереди и добавлять в них комментарии, вложения и пункты чеклиста. Если вы работаете с CLI без ИИ-ассистента, отключите проверку параметром --ai-access-check=off или командой ytracker config set ai-access-check off.

Чтобы отправить прямой запрос к API Трекера, используйте команду ytracker api. Для прямого запроса CLI не может проверить доступ для AI инструментов, поэтому команда работает только при отключенной проверке. Укажите путь относительно https://api.tracker.yandex.net/v3/. Например:

ytracker --ai-access-check=off api GET issues/TEAM-42

Команда ytracker api использует ту же авторизацию, что и другие команды, и выводит JSON с полями status, headers и body.

Узнайте больше