Welcome to Cheshire-Cat, the revolutionary framework designed for building customized AI applications atop any language model. If you’ve previously used platforms like WordPress or Django for web applications, think of Cheshire-Cat as your go-to tool for AI development!

Quickstart Guide

Ready to dive into the world of AI? Here’s how to get Cheshire Cat running on your machine.

• First, ensure you have Docker installed on your system.
• Run the following command in your terminal:

docker run --rm -it -p 1865:80 ghcr.io/cheshire-cat-ai/core:latest

• Access the interface by navigating to localhost:1865/admin.
• For API interaction, check out the documentation at localhost:1865/docs.
• Configure your favorite language model through the Settings page once inside the admin panel.

Enjoy exploring the endless possibilities with the Cheshire Cat!

Understanding the Code with an Analogy

Let’s take a closer look at the plugin example provided in the documentation:

from cat.mad_hatter.decorators import tool, hook

@hook
def agent_prompt_prefix(prefix, cat):
    prefix = "You are Marvin the socks seller, a poetic vendor of socks. You are an expert in socks, and you reply with exactly one rhyme."
    return prefix

@tool(return_direct=True)
def socks_prices(color, cat):
    prices = {
        'black': 5,
        'white': 10,
        'pink': 50
    }
    price = prices.get(color, 0)
    return f"{price} bucks, meeeow!"

Imagine you’re at a fancy restaurant (the plugin system) with a menu (the code). Each item on the menu represents a different function you can use to enhance your dining experience (your AI application).

• The agent_prompt_prefix function is like a waiter who introduces you to a special dish, giving you a delightful narrative about Marvin, the sock seller.
• The socks_prices function calculates prices for you, like the bill you receive at the end of your meal. Depending on the ‘color’ of your socks order, you’ll see a specific price, much like how your choices lead to different dishes on a menu.

With Cheshire-Cat, these functions dynamically evolve to cater to user interactions, just as the restaurant adapts its service to meet its patrons’ needs.

Troubleshooting Tips

If you encounter any issues while setting up or using Cheshire-Cat, here are some troubleshooting ideas:

• Double-check that Docker is running correctly on your machine.
• Ensure that the ports (1865 in this case) are not blocked by your firewall.
• If the admin panel doesn’t load, try clearing your browser cache or using a different browser.
• Consult the official documentation for detailed guides and tips.
• For further assistance and community support, join us on our Discord Server.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Why Choose Cheshire-Cat?

Here are some compelling reasons to adopt the Cheshire-Cat framework:

• API-first design, ideal for adding conversational layers to your application.
• Memorable conversations that improve with each interaction.
• Expandable via plugins, allowing for both public and private options.
• Supports any language model including OpenAI and HuggingFace.
• User-friendly admin panel to chat, visualize memory, and manage plugins.
• Active community support on Discord.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.

Ready to Join Cheshire-Cat?

Now that you have a clearer understanding of Cheshire-Cat, it’s time to unleash the potential of AI in your projects. Dive deep into the documentation, explore your creativity, and enjoy creating innovative AI solutions!