system/tools/README.md

Tools — CLI инструменты платформы

Версия: 1.0.0
Дата: 2025-12-21


Описание

Раздел содержит CLI инструменты для автоматизации задач разработки.


Инструменты

Инструмент Команда Назначение
project-docs project-docs Генератор документации проектов

project-docs

Генератор стандартизированной документации для проектов.

Установка

Скрипт уже доступен глобально:

project-docs --help

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

# Инициализация проекта
project-docs init                     # Базовый проект
project-docs init --type drupal       # Drupal проект
project-docs init --type python       # Python проект
project-docs init --type api          # API сервис
project-docs init --type solution     # Бизнес-решение
project-docs init --type library      # Библиотека

# Дополнительные команды
project-docs list                     # Показать шаблоны
project-docs validate                 # Проверить структуру
project-docs add docs/API.md          # Добавить документ

Типы проектов

Тип Документы
default CLAUDE.md, PROJECT.md, ARCHITECTURE.md, SETUP.md, TODO.md, CHANGELOG.md, STATUS.md
drupal + STACK.md, TESTING.md, THEMING.md
python + API.md, TESTS.md
api + ENDPOINTS.md, AUTH.md, ERRORS.md
solution + CHECKLIST.md, REQUIREMENTS.md
library + USAGE.md

Добавление нового инструмента

  1. Создать папку tools/{name}/
  2. Добавить скрипт {name}.py или {name}.sh
  3. Создать symlink: ln -sf $PWD/{name}.py /usr/local/bin/{name}
  4. Добавить README.md с документацией
  5. Обновить этот файл и system/INDEX.md

Версия: 1.0.0