Skip to content

utility for generating a project.md file containing a list of files and their contents.

License

Notifications You must be signed in to change notification settings

Buff2out/ginpee

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ginpee

ginpee — утилита для генерации project.md, содержащего дерево файлов и их содержимое.
Полезна для документирования структуры проекта, передачи контекста ИИ или коллегам.

Установка

cargo install --path .

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

Инициализация

ginpee init

Создаёт:

  • ginpee.toml — конфигурационный файл.
  • .gpskip — файл игнорирования (аналог .gitignore).

Генерация project.md

ginpee run

Сгенерирует project.md с деревом и содержимым файлов.

Флаги:

  • --output <file> — указать имя файла (по умолчанию project.md).
  • --top "<text>" — добавить текст в начало.
  • --down "<text>" — добавить текст в конец.
  • --files "*.rs" "README.md" — включить только указанные файлы.

Конфигурация

ginpee.toml:

[top]
text = "Текст сверху"

[down]
text = "Текст снизу"

[files]
include = ["*.с", "*.h", "Makefile", "*.py"]

Игнорирование

Файл .gpskip используется для игнорирования файлов и папок (по умолчанию включает .git/, target/, и т.д.).

Лицензия

MIT

About

utility for generating a project.md file containing a list of files and their contents.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages