Download the PHP package webgrafia/cheshire-cat-sdk-laravel without Composer

On this page you can find all versions of the php package webgrafia/cheshire-cat-sdk-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of webgrafia/cheshire-cat-sdk-laravel

Informations about the package cheshire-cat-sdk-laravel

Cheshire Cat SDK for Laravel

Laravel SDK for interacting with Cheshire Cat AI API, providing seamless integration with endpoints for messages, user management, settings, memory, plugins, and more.

API Reference and Versioning

This SDK is built to interact with the Cheshire Cat API. For a comprehensive list of all available endpoints, their parameters, and expected responses, please refer to the OpenAPI specification file.

Version Compatibility: The openapi.json file also indicates the specific version of the Cheshire Cat API that this SDK is designed to work with. This ensures compatibility and helps you understand the features and functionalities supported by the SDK.

Current API Version: 1.9.0 (as per openapi.json)

Installation

  1. Install the package via Composer:

  2. Publish the configuration file:

  3. Update .env with Cheshire Cat API credentials:

Default Routes

The SDK provides 2 default route /meow/status and /meow/hello that can be used to check the status of the Cheshire Cat API.

Usage

To check the status of the API, simply navigate to http://your-app-domain/meow/status in your browser. To say Hello to Cheshire simply navigate to http://your-app-domain/meow/hello in your browser.

This routes will return a message indicating whether the API connection was successful or not, along with the status response or any error messages.

Configuration

The published configuration file is located at config/cheshirecat.php:

Usage

Use the CheshireCat Facade or the CheshireCat class directly.

Examples

Methods

1. Status Check

2. Send a Message

3. Get Available Permissions

4. User Management

5. Manage Settings

6. Memory Management

7. Plugin Management

WebSocket Connection

The SDK supports WebSocket connections for real-time communication with the Cheshire Cat AI server.

WebSocket Basic Usage Example

Rabbit Hole File Upload

Upload a file to the API via the /rabbithole/ endpoint.

Parameters:

Response:

Custom route for Testing

example of route in web.php for testing

Contributing

Feel free to fork this repository and submit pull requests.

License

This package is open-source software licensed under the GNU GENERAL PUBLIC LICENSE.

All versions of cheshire-cat-sdk-laravel with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
guzzlehttp/guzzle Version ^7.0
textalk/websocket Version ^1.5
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package webgrafia/cheshire-cat-sdk-laravel contains the following files

Loading the files please wait ....