FlipFlag CLI

FlipFlag CLI — это лёгкий инструмент командной строки, который помогает разработчикам декларировать задачи и рабочее время прямо в репозитории.

Установка

Для работы CLI требуется установленная среда Node.js (включает менеджер пакетов npm). Установить CLI можно одним из способов:

Глобальная установка

npm install -g @flipflag/cli

Локальная установка (в проект)

npm install @flipflag/cli --save-dev

Запуск

С командной строке выполните:

flipflag

Формат файла .flipflag.yml

Пример:

TASK-1:
  description: ""
  contributor: "dev@example.com"
  type: "feature"
  times:
    - started: "2025-01-01T10:00:00.000Z"
      finished: "2025-01-01T12:30:00.000Z"
    - started: "2025-01-02T09:00:00.000Z"
      finished: null

Этот файл обновляется автоматически при использовании CLI.

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

Начать работу над задачей

flipflag start TASK-ID

Если TASK-ID не указан, CLI предложит ввести его интерактивно. При старте CLI может попросить указать:

• тип задачи (feature или bugfix);
• нужно ли создать/перейти на Git-ветку;
• включать ли трекинг времени.

Параметры команды start

Пример:

flipflag start TASK-2 --type=bugfix --branch --time

Остановить работу над задачей

Чтобы завершить рабочую сессию:

flipflag stop TASK-ID

Если идентификатор задачи не указан, CLI запросит его.

Синхронизация флагов с FlipFlag API

Команда flipflag sync позволяет загружать feature flags из файла .flipflag.yml на платформу FlipFlag:

flipflag sync

Для работы требуется приватный ключ API. Рекомендуется использовать переменную окружения:

export FLIPFLAG_PRIVATE_KEY="priv_ваш_ключ"
flipflag sync

Или передать ключ напрямую:

flipflag sync --private-key "priv_ваш_ключ"

Дополнительные параметры

• --config PATH — путь к конфигурационному файлу (по умолчанию .flipflag.yml)
• --api-url URL — URL API сервера для self-hosted решений
• --public-key KEY — публичный ключ API (опционально)

Подробнее об интеграции с CI/CD пайплайнами: см. Интеграция с CI/CD

Git-ветки (feature/bugfix)

Если включён флаг --branch, CLI автоматически создаёт или использует существующую ветку:

• для фич: feature/TASK-ID
• для багфиксов: bugfix/TASK-ID

Если ветка уже существует, то CLI просто переключится на неё, иначе создаст и переключится.

Отслеживание времени

Если включён --time, команда flipflag start:

1. создаёт запись времени с началом работы;
2. ждёт, пока вы нажмёте Enter;
3. фиксирует окончание работы.

Пример:

flipflag start TASK-5
# …работа…
# нажмите Enter для остановки трекинга

CLI автоматически обновит .flipflag.yml соответствующим временем.

Помощь и справка

Чтобы получить список доступных команд и описаний:

flipflag help

Переменные окружения

Если в Git не настроен email пользователя, CLI может использовать переменную:

FLIPFLAG_USER="myname@example.com"

Она будет подставлена как email контрибьютора в .flipflag.yml.

Примеры типичного рабочего процесса

Работа над задачей с веткой и трекингом:

flipflag start TASK-10 --type=feature --branch --time
# …работа…
# нажмите Enter после завершения
flipflag stop TASK-10

Начало задачи без трекинга времени:

flipflag start TASK-21 --no-time --no-branch