Skip to content

Prompt Generator is a flexible and user-friendly package that offers customizable scripts for generating meaningful and context-aware prompts. These prompts can be used to guide the writing, enhancement, and debugging of code.

License

Notifications You must be signed in to change notification settings

vincenzocascone/prompt-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Prompt Generator

Prompt Generator is a flexible and user-friendly package that offers customizable scripts for generating effective and context-aware prompts. These prompts can be used to guide the writing, improvement, and debugging of code.

Installation

Prompt Generator can be installed easily using pip, a package installer for Python:

pip install prompt-generator

Features

  • Markdown Parser

    The Markdown Parser is a robust utility specifically designed to parse markdown files. It works by replacing all hyperlinks within a Markdown document with the actual content of the linked files. This function proves extremely useful if you maintain a collection of prompt files written in Markdown format, and these files contain references to other project documents.

    To utilize it, use the following command in your terminal:

    parse_md <path to the markdown file>

    Upon successful execution, the resultant parsed content will be displayed in your terminal and copied to your clipboard for immediate use or future reference.

  • Directory Structure

    This tool provides a clear, nested representation of the structure of a directory in your project. It has been designed with gitignore compatibility, meaning it will respect the file exclusion rules defined in your project's .gitignore file. This makes it an essential tool for giving the AI a better understanding of the context of your project. The returned JSON is minified in order to be more token efficient.

    To utilize it, use the following command in your terminal. You can optionally provide the .gitignore file path using the -gitignore flag, if not provided, the script will search for a .gitignore file in the root directory:

    get_directory_structure <path to the directory> [-gitignore]

    Upon successful execution, the resultant json will be displayed in your terminal and copied to your clipboard for immediate use or future reference.

About

Prompt Generator is a flexible and user-friendly package that offers customizable scripts for generating meaningful and context-aware prompts. These prompts can be used to guide the writing, enhancement, and debugging of code.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages