manticoresoftware/buddy-plugin-knn

This package is abandoned and no longer maintained. No replacement package was suggested.

The Buddy KNN doc joiner plugin

dev-main 2024-01-11 11:34 UTC

Requires

• manticoresoftware/buddy-core: dev-main

Requires (Dev)

• phpstan/phpstan: ^1.8
• phpunit/phpunit: ^9.5
• slevomat/coding-standard: ^8.5
• squizlabs/php_codesniffer: ^3.7

GPL-2.0-or-later

• Manticore Software Co. Ltd

README

This is an initial template of a plugin for Buddy that you can use to develop.

How to start

1. Create a repository from this template.
2. Open composer.json and edit it with your plugin name, dependencies, and everything else you need.
3. Run composer install to make it work.
4. You need to use our official manticore-executor; we strictly recommend using the Docker flow.
5. Edit src/Payload.php, add logic to parse the request, and prepare the payload structure for your command processing.
6. Edit src/Handler.php and implement processing logic and response that will be proxied by Manticore to the client.

How to use Docker of manticore-executor-dev

1. Clone Buddy somewhere to your host machine and go into it.

2. Run this command to create a Docker image named manticore-buddy:

   docker run --privileged --entrypoint bash -v $(pwd):/workdir -w /workdir --name manticore-buddy  --network host -it manticoresearch/manticore-executor-kit:latest

3. Now you can edit /etc/manticore.conf and configure the development version of Buddy:

   buddy_path = manticore-executor-dev /workdir/src/main.php --debug
   

4. Run searchd --nodetach to keep the daemon in the foreground and enjoy the development of your new plugin.

Notes

You can use pre-commit to install code style and code analyze hooks by running pre-commit install. Check our PHP code style and guide here.