search

mostlyserious / craft-promptly

Revolutionize content creation in Craft by leveraging the power of AI, giving superpowers to your content creators to help them brainstorm and edit content with an AI assistant directly within Craft CMS.
Other
0 stars 1 forks source link

readme

Promptly

Promptly

Revolutionize content creation in Craft by leveraging the power of AI, giving superpowers to your content creators to help them brainstorm and edit content with an AI assistant directly within Craft CMS.

Looking to utilize Promptly on your project? Read our blog post on using Promptly.

Features

Promptly offers four tailored prompt categories to help you manage your content:

Built With Content in Mind

The Brainstorm and Edit prompts are designed to ensure the results you receive from GPT are aligned with your existing content, and you can add keywords to help shape the response to your precise needs.

Using Custom Prompts, your options are nearly limitless. Here are just a few examples of what you can use AI to accelerate:

Install Promptly to add an AI assistant to elevate your content creation process, save time and money, and bring the advantages of AI directly into Craft CMS.

Installation

You can install this plugin from the Plugin Store or with Composer.

From the Plugin Store
Go to the Plugin Store in your project’s Control Panel and search for “Promptly”. Then click on the “Install” button in its modal window.

With Composer
Open your terminal and run the following commands:

# go to the project directory
cd /path/to/my-project

# tell Composer to load the plugin
composer require mostlyserious/craft-promptly

# tell Craft to install the plugin
php craft plugin/install promptly

Overriding Plugin Settings

If you create a config file in your /config folder called promptly.php, you can override the plugin's settings in the Control Panel. Since that config file is fully multi-environment aware, this is a handy way to have different settings across multiple environments.

Here’s what that config file might look like along with a list of all of the possible values you can override.

<?php

use craft\helpers\App;

return [
    'openAiKey' => App::env('OPENAI_API_KEY'),
    'gptModel' => 'gpt-4' // or gpt-3.5-turbo
];

‼️ Promptly has been tested with gpt-4 and gpt-3.5-turbo and these are the only two values available from the Control Panel. However, any OpenAI GPT model that uses the chat endpoint should work and as of the time this writing includes: gpt-4, gpt-4-0613, gpt-4-32k, gpt-4-32k-0613, gpt-3.5-turbo, gpt-3.5-turbo-0613, gpt-3.5-turbo-16k, and gpt-3.5-turbo-16k-0613.

OpenAI API Pricing

With the Promptly plugin, you'll have two separate costs: licensing for the plugin itself and another for the AI-generated content from OpenAI. The plugin provides seamless Craft integration with OpenAI's API, custom prompting, and a user-friendly interface. Please note that you'll be billed separately for content generated by OpenAI's API based on their pay-for-what-you-use model. You can learn more about pricing and your OpenAI API key on OpenAI's website.

Short-Term Roadmap

Mostly Serious