Skip to content

Repository files navigation

Tyver CLI

Удобный CLI и Python-клиент для полного покрытия Tyver Public API v1. Ориентирован на автоматизацию и вызовы из AI-агентов: JSON по умолчанию, предсказуемые коды выхода, JSONL для потоковой обработки и отсутствие секретов в аргументах командной строки.

English documentation · Русское руководство · Skill для агентов · Официальная документация · OpenAPI 3.1

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

Требуется Python 3.11+ и желательно uv.

git clone https://github.com/dvygolov/tyver-cli.git
cd tyver-cli
Copy-Item .env.example .env
# Впишите TYVER_API_KEY=tyv_... в .env

uv sync --extra dev
uv run tyver me
uv run tyver creatives search --country RU --media-type VIDEO

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

uvx tyver-cli me

При таком запуске передайте ключ через переменную окружения или --env-file C:\safe\path\.env.

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

tyver me
tyver creatives search [ВСЕ ФИЛЬТРЫ API]
tyver creatives get PROVIDER_ID
tyver blacklist list
tyver blacklist add FAN_PAGE_ID
tyver blacklist remove FAN_PAGE_ID
tyver api request METHOD PATH
tyver api coverage
tyver config show
tyver config init

CLI явно реализует все 6 операций текущей схемы. Команда api coverage получает живую OpenAPI-схему и завершится с кодом 7, если Tyver добавит операцию, для которой еще нет явной команды. api request остается универсальным запасным путем для новых методов.

Примеры для агента

# Точный поиск, повторяемые параметры передаются отдельными флагами
tyver creatives search `
  --search '\"some phrase\"' `
  --country RU --country KZ `
  --media-type VIDEO `
  --creation-date-gte 2026-07-01 `
  --output json

# Все страницы как поток: один креатив — одна строка JSON
tyver creatives search --vertical GAMBLING --all-pages --max-pages 5 -o jsonl

# Форвард-совместимый прямой вызов
tyver api request GET creatives/ -q countries=RU -q media_types=IMAGE

Секрет читается из TYVER_API_KEY и отправляется только в заголовке X-Tyver-Authorization. Файл .env исключен из Git.

Skill для AI-агентов

Рядом с CLI находится готовый skill tyver-search. Он переводит обычные запросы пользователя в фильтры Tyver, бережно работает с лимитом просмотров, анализирует результаты и не раскрывает API-ключ.

Пример обращения к агенту:

$tyver-search найди свежие видео-креативы гемблинга для России

Wrapper можно запускать напрямую из корня репозитория:

& '.\skills\tyver-search\scripts\tyver.ps1' `
  creatives search --country RU --media-type VIDEO

Для установки skill скопируйте весь каталог skills/tyver-search в каталог навыков Codex. Если установленная копия находится отдельно от репозитория, задайте путь к CLI:

$env:TYVER_CLI_PROJECT = 'C:\path\to\tyver-cli'

Локальная рабочая копия уже установлена в общей базе навыков пользователя.

About

Agent-friendly CLI and Codex skill for the Tyver Public API

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages