Skip to content
Cheshire Cat AI docs
Search
Ctrl
K
Cancel
GitHub
Discord
Select theme
Dark
Light
Auto
Version
v2 (latest)
v1
Quickstart
Install
Message the Cat
Create a Plugin
Write the first Tool
Write the first Hook
Conclusion
Plugins
Install a Plugin
How to Write a Plugin
Write an Agent
Tools
Hooks
Custom Endpoints
Logging
Settings
Dependencies
Examples
Hooks API Reference
Flow
`before_cat_reads_message`
`cat_recall_query`
`before_cat_recalls_memories`
`before_cat_recalls_episodic_memories`
`before_cat_recalls_declarative_memories`
`before_cat_recalls_procedural_memories`
`after_cat_recalls_memories`
`before_cat_stores_episodic_memory`
`before_cat_sends_message`
Agent
`before_agent_starts`
`agent_fast_reply`
`agent_allowed_tools`
`agent_prompt_prefix`
`agent_prompt_suffix`
Rabbit Hole
`rabbithole_instantiates_parsers`
`rabbithole_instantiates_splitter`
`before_rabbithole_insert_memory`
`before_rabbithole_splits_text`
`after_rabbithole_splitted_text`
`before_rabbithole_stores_documents`
`after_rabbithole_stored_documents`
Factory
`factory_allowed_llms`
`factory_allowed_embedders`
`factory_allowed_auth_handlers`
Lifecycle
`before_cat_bootstrap`
`after_cat_bootstrap`
Registry
Using the Plugin Template
Publishing a Plugin
Deploy
Make the Cat Private
Environment Variables
Automatic Tests
Backups and Updates
Network
HTTP Endpoints
Auth
Authentication
Authorization
User Management
Custom Auth
FAQ
General
Basic Info
Errors
Customization
Security & Spending
Concepts
Language Models
Retrieval Augmented Generation
Prompt
Encoder
Vector Memory
GitHub
Discord
Select theme
Dark
Light
Auto
Publishing a Plugin in the Registry
