promptr
6.0.7
PROMPTR - это инструмент CLI, который позволяет использовать простой английский для инструктажа OpenAI LLM для внесения изменений в вашу кодовую базу. Изменения применяются непосредственно к файлам, на которые вы ссылаетесь из вашей подсказки.
promptr [options] -p "your instructions" <file1> <file2> <file3> ...
Я обнаружил, что это хороший рабочий процесс:
-p : promptr -p my_prompt.txtPROMPTR будет применять код модели непосредственно к вашим файлам. Используйте свой любимый интерфейс GIT, чтобы осмотреть результаты.
Приведенные ниже пиарщики являются хорошими примерами того, что может быть достигнуто с помощью PROMPTR. Вы можете найти ссылки на отдельные коммиты и подсказки, которые создали их в описаниях PR.
PROMPTR поддерживает шаблон с использованием LiquidJS, что позволяет пользователям включать команды шаблонов в свои приглашенные файлы. Эта функция повышает гибкость и возможности повторного использования подсказок, особенно при работе над более крупными проектами с повторяющимися моделями или стандартами.
Проекты могут иметь один или несколько «включает в себя» - повторные фрагменты кода или инструкций - которые могут быть включены из оперативного файла. Они включают в себя стандарты, специфичные для проекта, инструкции или шаблоны кода, что позволяет пользователям поддерживать согласованность по всей своей кодовой базе.
Например, у вас может быть файл включения с именем _poject.liquid со следующим контентом:
This project uses Node version 18.
Use yarn for dependency management.
Use import not require in Javascript.
Don't include `module.exports` at the bottom of Javascript classes.
Alphabetize method names and variable declarations. В вашем файле приглашения вы можете использовать функцию render от LiquidJs, чтобы включить его, включить файл в файл быстрого приглашения, с которым вы работаете:
{% render '_project.liquid' %}
// your prompt hereЭтот подход позволяет разработать повторно использование, включающие файлы, которые можно обмениваться по нескольким проектам или в разных частях одного и того же проекта.
Стандарты кодирования по всему проекту : Создайте файл включения с комментариями с изложением стандартов кодирования и включите его в каждый новый файл кода для проекта.
Код паттерной пластины : Разработайте набор фрагментов кода шаблона для разных частей приложения (например, определения модели, конечные точки API) и включите их по мере необходимости.
Общие инструкции : Сохраняйте набор инструкций или руководящих принципов для конкретных задач (например, как документировать функции) и включите их в соответствующие файлы быстрого приглашения.
Используя функцию шаблона, инженеры -быстрого инженера могут значительно снизить избыточность и обеспечить согласованность в быстрого создания, что приведет к более эффективным и стандартизированным модификациям кодовой базы.
| Вариант | Описание |
|---|---|
-p, --prompt <prompt> | Определяет подсказку для использования в неинтерактивном режиме. Также можно указать путь или URL -адрес - в данном случае содержание в указанном пути или URL -адресе используется в качестве приглашения. Подсказка может использовать систему шаблона LiquidJS. |
-m, --model <model> | Необязательный флаг, чтобы установить модель, по умолчанию в gpt-4o . Использование значения «GPT3» будет использовать модель gpt-3.5-turbo . |
-d, --dry-run | Необязательный логический флаг, который можно использовать для запуска инструмента в режиме сухого управления, где отображается только приглашение, которая будет отправлена на модель. В вашей файловой системе не внесено никаких изменений, когда используется эта опция. |
-i, --interactive | Необязательный логический флаг, который позволяет интерактивному режиму, в котором пользователь может предоставить вход интерактивно. Если этот флаг не установлен, инструмент работает в неинтерактивном режиме. |
| `-t, -template <TemplateName | шаблон |
-x | Необязательный логический флаг. PROMPTR анализирует ответ модели и применяет полученные операции к вашей файловой системе при использовании шаблона по умолчанию. Вам нужно передать флаг -x только в том случае, если вы создали свой собственный шаблон, и вы хотите, чтобы PROMPTR проанализировал и применил выход так же, как встроенный выход «рефактор» шаблон проанализируется и применяется к вашей файловой системе. |
-o, --output-path <outputPath> | Необязательный флаг строк, который указывает путь к выходному файлу. Если этот флаг не установлен, выход будет напечатан в Stdout. |
-v, --verbose | Необязательный логический флаг, который обеспечивает многословный выход, предоставляя более подробную информацию во время выполнения. |
-dac, --disable-auto-context | Предотвращает автоматическое включение файлов, упомянутых в подсказке в контекст, отправленный в модель. |
--version | Отображать версию и выйти |
Дополнительные параметры могут указывать пути к файлам, которые будут включены в качестве контекста в приглашение. Параметры должны быть разделены пространством.
yarn global add @ifnotnowwhen/promptr
npm install -g @ifnotnowwhen/promptr
Вы можете установить PRODPTR, копировав двоичный файл для текущего выпуска на ваш путь. Только macOS поддерживается прямо сейчас.
Ожидается, что переменная среды под названием OPENAI_API_KEY будет содержать ваш секретный ключ API Openai.
npm run bundle
npm run build:<platform win|macos|linux>
npm run test-binary
PROMPTR выпускается по лицензии MIT.
