Stars: 265
Forks: 9
Pull Requests: 4
Issues: 1
Watchers: 4
Last Updated: 2023-09-11 00:43:38
Generate Laravel code with ChatGPT
License: MIT License
Languages: PHP
(Not an official Laravel package)
Synth is a Laravel tool that helps you generate code and perform various tasks in your Laravel application. It leverages the power of OpenAI's GPT language model to provide an interactive and intelligent development experience.
Install the Synth package using Composer:
composer require blinq/synth
Publish the Synth configuration file:
php artisan vendor:publish --tag=synth-config
Here you can change the used model (gpt4 versus gpt3)
Set your OpenAI API key in the .env
file:
OPENAI_KEY=YOUR_API_KEY
To use Synth, simply run the synth
command:
php artisan synth
This will open the Synth CLI, where you can interact with the GPT model and perform various tasks.
You can select a module from the main menu and follow the prompts to perform the desired actions.
Note: Some modules require a previous step to be completed, such as creating an architecture before generating migrations or models.
Synth allows you to extend its functionality by writing your own modules. A module is a class that implements the necessary methods to register and handle specific actions.
To create a new module, follow these steps:
Module
class.name
method to define the name of your module.register
method to define the actions provided by your module.onSelect
method to handle the selected action.Here is an example of a custom module implementation:
use Blinq\Synth\Modules\Module;
/**
* Class MyModule
*
* @propery \Blinq\Synth\Commands\SynthCommand $cmd
*/
class MyModule extends Module
{
public function name(): string
{
return 'MyModule';
}
public function register(): array
{
return [
'action1' => 'Perform Action 1',
'action2' => 'Perform Action 2',
];
}
public function onSelect(?string $key = null)
{
$this->cmd->info("You selected: {$key}");
$synth = $this->cmd->synth;
if ($key === 'action1') {
// Handle Action 1
while (true) {
$input = $this->cmd->ask("You");
// Send the input to GPT
$synth->chat($input, [
// ... The OpenAI Chat options
// If you want a function to be called by GPT
'function_call' => ['name' => 'some_function'], // Forces the function call
'functions' => [
[
'name' => 'some_function',
'description' => 'Description of the function',
'parameters' => [
// ..schema
]
]
]
]);
Functions::register('some_function', function (SynthCommand $cmd, $args, $asSpecified, $inSchema) { // etc..
// Do something with the call
});
// This will parse the json result and call the function if needed
$synth->handleFunctionsForLastMessage();
// Just retrieve the last message
$lastMessage = $synth->getLastMessage();
// Echo it's contents
echo $lastMessage->content;
// Or it's raw function_call
dump($lastMessage->function_call);
if (!$input || $input == 'exit') {
break;
}
}
}
if ($key === 'action2') {
// Handle Action 2
}
}
}
You can then register your custom module in the Modules
class within the Synth package and use it in the CLI interface:
use Blinq\Synth\Modules;
Modules::register(MyModule::class);