Codex Specify CLI

Node.js CLI инструмент для генерации спецификаций кода и проектной документации.

Возможности

• Инициализация спецификаций проекта с .spec/* и templates/*
• Генерация документации из шаблонов
• Кроссплатформенная поддержка (Windows, macOS, Linux)
• Архитектура на основе ESM
• Поддержка TypeScript

Установка

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

npm install -g codex-specify

Локальное использование

npx codex-specify

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

Инициализация проекта

codex-specify init

Генерация документации

# Генерация спецификационного документа
codex-specify generate spec

# Генерация плана реализации
codex-specify generate plan

# Генерация разбивки задач
codex-specify generate tasks

Кастомный путь вывода

codex-specify generate spec --output path/to/spec.md
codex-specify generate plan --output path/to/plan.md
codex-specify generate tasks --output path/to/tasks.md

Структура проекта

ваш-проект/
├── .spec/
│   ├── manifest.yaml.hbs
│   ├── state.json.hbs
│   ├── entry.md.hbs
│   ├── steps/
│   │   ├── specify.md.hbs
│   │   ├── plan.md.hbs
│   │   ├── tasks.md.hbs
│   │   └── implement.md.hbs
│   └── rules/
│       ├── coding.md
│       ├── arch.md
│       ├── ui.md
│       ├── a11y_perf.md
│       ├── security.md
│       └── git.md
├── templates/
│   ├── spec.md.hbs
│   ├── plan.md.hbs
│   └── tasks.md.hbs
└── docs/
    ├── spec.md
    ├── plan.md
    └── tasks.md

Разработка

Предварительные требования

• Node.js >= 18
• TypeScript >= 5.0

Настройка

git clone <репозиторий>
cd codex-specify
npm install

Сборка

npm run build

Режим разработки

npm run watch

Тестирование

npm test

Шаблоны

CLI использует шаблоны Handlebars для генерации документации. В шаблоны доступны следующие переменные:

• {{project}} - Название проекта
• {{stack}} - Технологический стек
• {{date}} - Текущая дата

Скрипты

Добавьте эти скрипты в ваш package.json для удобного использования:

{
  "scripts": {
    "spec:spec": "codex-specify generate spec",
    "spec:plan": "codex-specify generate plan",
    "spec:tasks": "codex-specify generate tasks"
  }
}

Вклад в развитие

1. Форкните репозиторий
2. Создайте ветку для функции
3. Внесите изменения
4. Добавьте тесты, если применимо
5. Отправьте pull request

Лицензия

MIT License - смотрите файл LICENSE для деталей.

Изменения

v0.0.1

• Начальный релиз
• Базовая функциональность CLI
• Генерация шаблонов
• Кроссплатформенная поддержка