Skip to content

Latest commit

 

History

History
180 lines (127 loc) · 6.55 KB

README.md

File metadata and controls

180 lines (127 loc) · 6.55 KB
Raw

Agnaistic

AI Roleplay Chat with Personalized Characters using your favorite AI services.

Live Version | Discord

Visit the live version at Agnai.chat.

Based on the early work of Galatea-UI by PygmalionAI.

Quick Start

Important! MongoDB and Redis are optional! Agnaistic will run in "Guest Only" mode if MongoDB is not available.

Agnaistic is published as an NPM package and can be installed globally:

# Install or update:
npm install agnai -g
agnai

# View launch options:
agnai help

# Run with the Pipeline features
agnai --pipeline

When using the NPM package, your images and JSON files will be stored in: HOME_FOLDER/.agnai.
Examples:
Linux: /home/sceuick/.agnai/
Mac: /Users/sceuick/.agnai
Windows: C:\Users\sceuick\.agnai.

Features

  • Group Conversations: Multiple users with multiple bots
  • Multiple AI services: Support for Kobold, Novel, AI Horde, Goose, OpenAI, Claude, Replicate, OpenRouter, Mancer
  • Multiple persona schema formats: W++, Square bracket format (SBF), Boostyle, Plain text
  • Multi-tenancy:
    • User authentication
    • User settings: Which AI service to use and their own settings
    • User generation presets
  • Subscriptions
  • Memory/Lore books
  • Generate characters with AI
  • Image generation using third-party services
  • Optional pipeline features
    • Long-term memory
    • Wikipedia Article and PDF embedding

Running Manually

  1. Install Node.js
  2. Install MongoDB Optional
    • The database is optional. Agnaistic will run in anonymous-only mode if there is no database available.
    • Anonymous users have their data saved to the browser's local storage. Your data will "persist", but not be shareable between devices or other browsers. Clearing your browser's application data/cookies will delete this data.
  3. Download the project: git clone https://github.com/agnaistic/agnai or download it
  4. From inside the cloned/unpacked folder in your terminal/console:
    • npm run deps
      • Do this every time you update AgnAI, just in case.
      • This will install the dependencies using pnpm v8
    • npm run build:all
    • Build and run the project in watch mode:
      • Mac/Linux: npm run start
      • Windows: npm run start:win
    • Build and run the project with Local Tunnel:
      • Mac/Linux: npm run start:public
      • Windows: npm run start:public:win

Running with Docker

  1. Clone the project
  2. With MongoDB: docker compose -p agnai -f self-host.docker-compose.yml up -d
  3. Without MongoDB: docker run -dt --restart=always -p 3001:3001 ghcr.io/agnaistic/agnaistic:latest
    • -dt Run the container detached
    • --restart=always Restart at start up or if the server crashes
    • -p 3001:3001 Expose port 3001. Access the app at http://localhost:3001

Self-Hosting Settings

To try and cater for the small tweaks and tuning that people need for their specific needs at an application level we have settings.json.
You can create a file called settings.json at the root level to apply some changes across the entire application.
If you have a specific need for your application, this is the place to ask to have it catered for.

I will try and find a balance between catering to these requests and not having them get out of control in the codebase.

Examples of requests that are suited for this:

  • I want a "default memory book" applied to all users.
  • I want to use a different set of end tokens than the ones provided.
  • I want to disable anonymous access

settings.json

You can copy or look at template.settings.json for an example of all of the available settings. You will need to restart Agnai for changes to take effect.

Currently supported custom settings:

  • baseEndTokens: Add extra response end tokens to the base set.

For Developers

Recommended Development Tooling

I'd highly recommend using VSCode with the following extensions:

  • Prettier - Code formatter: For auto-formatting
  • Tailwind CSS Intellisense: For auto-completion and intellisense with Tailwind CSS classes
  • And adding "editor.formatOnSave": true to your VSCode settings.json to auto-format with Prettier

When using pnpm start, the Node.JS server is run using --inspect. This means you can use various Inspector Clients for debugging.

Tech Stack

The important parts of the stack are:

Starting

# Install dependencies - Always run this after pulling changes
> npm run deps

# Run MongoDB using Docker
> npm run up

# Start the frontend, backend, and python service
# Mac/Linux
> npm start

# Windows
> npm run start:win

# Install and run Pipeline API
# If required, this will update the dependencies before running the API
> npm run model # Install poetry into a virtual environment

# Run everything with a single command:
> npm run start:all # Linux and OSX
> npm run start:all:win # Windows

At this point, you should be able to access http://localhost:3001 in your browser to see the UI.

You can also try to access the frontend with hot reloading at http://localhost:1234

Recommended Developer Tooling

  • Redux Dev Tools
    • The front-end application state is wired up to the "Redux Dev Tools" Chrome extension.
  • NodeJS debugger
    • The pnpm start script launches the NodeJS API using the --inspect flag
    • Attach using the default launch task in VSCode (F5)
    • Or go to the url chrome://inspect to use the debugger
  • Python dependency management using Poetry - https://python-poetry.org/docs/cli
    • .model/bin/poetry [...args]

Format and Type Checking

The project uses ESLint for linting, Prettier for enforcing code style and TypeScript to check for type errors. When opening a PR, please make sure you're not introducing any new errors in any of these checks by running:

# auto-fixes any style problems
$ pnpm run format:fix

# runs the TypeScript compiler so any type errors will be shown
$ pnpm run typecheck

This project is tested with BrowserStack.