Welcome to the comprehensive guide on how to build and run Agnaistic AI, a roleplay chat application that allows you to engage with personalized characters using your favorite AI services. This guide will walk you through the installation process, set-up, and troubleshooting tips to ensure a smooth experience.
Quick Start
First things first, let’s dive into the essentials of Agnaistic AI. It’s published as an NPM package that can be easily installed globally. Before we begin, note the following:
- MongoDB and Redis are optional! Agnaistic will run in Guest Only mode if MongoDB is unavailable.
Installation Steps
To get started, follow these steps:
npm install agnai -g agnai
Once installed, you can view the launch options:
agnai help
Run Agnaistic with Pipeline features:
agnai --pipeline
Features
Agnaistic AI offers various innovative features:
- Group Conversations with multiple users and bots
- Support for multiple AI services like Kobold, Novel, AI Horde, Goose, OpenAI, Claude, and more
- Multiple persona schema formats: W++, Square bracket format (SBF), Boostyle, Plain text
- User authentication and customizable settings
- Subscriptions and MemoryLore books
- Image generation using third-party services
- Options for long-term memory and content embedding
Setting Up the Environment
Before running Agnaistic, ensure you have Node.js installed. If you choose to use MongoDB:
- Install MongoDB here (Optional)
- Download the project: Clone it using Git:
git clone https://github.com/agnaistic/agnai
npm run deps
npm run start
Running with Docker
Docker is a fantastic tool for managing your application in isolated environments. Here’s how to run Agnaistic with Docker:
- Clone the project
- Run the following command for MongoDB:
docker compose -p agnai -f self-host.docker-compose.yml up -d
docker run -dt --restart=always -p 3001:3001 ghcr.io/agnaistic/agnaistic:latest
Customizing Settings
The settings.json file plays a crucial role in personalizing your experience. You can create a settings.json file to manage application-level tweaks:
- Examples of customization:
- Default memory book for all users
- Custom end tokens for responses
Troubleshooting
If you run into any issues, consider the following:
- Ensure all dependencies are installed by running
npm run depsregularly. - Check your MongoDB connection settings.
- Verify that ports are not being blocked or used by other applications.
- If persistent data is important, ensure MongoDB is utilized; otherwise, it will run in anonymous-only mode.
For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.
Conclusion
Building and running your personalized AI chat experience with Agnaistic is a seamless journey if you follow these steps. From installing the necessary packages to managing settings for a customized experience, you now have what it takes to unleash the full potential of this innovative roleplay chat application.
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.

