agnai

男性主义

AI 角色扮演 使用您最喜欢的 AI 服务与个性化角色聊天。

现场版 |不和谐

请访问 Agnai.chat 访问实时版本。

基于 PygmalionAI 的 Galatea-UI 早期工作。

---

快速入门

重要的！ MongoDB 和 Redis 是可选的！如果 MongoDB 不可用，Agnaistic 将在“Guest Only”模式下运行。

Agnaistic 作为 NPM 包发布，可以全局安装：

 # Install or update:
npm install agnai -g
agnai

# View launch options:
agnai help

# Run with the Pipeline features
agnai --pipeline

使用 NPM 包时，您的图像和 JSON 文件将存储在： HOME_FOLDER/.agnai中。
示例：
Linux： /home/sceuick/.agnai/
Mac： /Users/sceuick/.agnai
Windows： C:Userssceuick.agnai 。

特征

• 群组对话：多个用户与多个机器人
• 多种AI服务：支持Kobold、Novel、AI Horde、Goose、OpenAI、Claude、Replicate、OpenRouter、Mancer
• 多种角色架构格式：W++、方括号格式 (SBF)、Boostyle、纯文本
• 多租户：
  • 用户认证
  • 用户设置：使用哪种AI服务以及自己的设置
  • 用户生成预设
• 订阅
• 记忆/知识书籍
• 用AI生成角色
• 使用第三方服务生成图像
• 可选管道功能
  • 长期记忆
  • 维基百科文章和 PDF 嵌入

手动运行

3. 安装 Node.js
4. 安装 MongoDB可选
   • 数据库是可选的。如果没有可用的数据库，Agnaistic 将在anonymous-only模式下运行。
   • Anonymous用户的数据保存到浏览器的本地存储中。您的数据将“持续存在”，但不能在设备或其他浏览器之间共享。清除浏览器的应用程序数据/cookie 将删除该数据。
5. 下载项目： git clone https://github.com/agnaistic/agnai或者下载
6. 从终端/控制台中克隆/解压的文件夹内：
   • npm run deps
     • 每次更新 AgniAI 时都执行此操作，以防万一。
     • 这将使用pnpm v8安装依赖项
   • npm run build:all
   • 在监视模式下构建并运行项目：
     • Mac/Linux： npm run start
     • Windows： npm run start:win
   • 使用本地隧道构建并运行项目：
     • Mac/Linux： npm run start:public
     • Windows: npm run start:public:win

使用 Docker 运行

1. 克隆项目
2. 使用 MongoDB： docker compose -p agnai -f self-host.docker-compose.yml up -d
3. 没有 MongoDB： docker run -dt --restart=always -p 3001:3001 ghcr.io/agnaistic/agnaistic:latest
   • -dt分离运行容器
   • --restart=always在启动时或服务器崩溃时重新启动
   • -p 3001:3001公开端口 3001。通过http://localhost:3001访问应用程序

自托管设置

为了尝试满足人们在应用程序级别的特定需求所需的小调整和调整，我们有settings.json 。
您可以在根级别创建一个名为settings.json的文件，以在整个应用程序中应用一些更改。
如果您对您的申请有特殊需求，可以在此要求满足您的需求。

我将尝试在满足这些请求和不让它们在代码库中失控之间找到平衡。

适合于此的请求示例：

• 我想要一个适用于所有用户的“默认记忆簿”。
• 我想使用与提供的结束令牌不同的一组结束令牌。
• 我想禁用匿名访问

设置.json

您可以复制或查看template.settings.json以获取所有可用设置的示例。您需要重新启动 Agnai 才能使更改生效。

目前支持的自定义设置：

• baseEndTokens ：将额外的响应结束标记添加到基本集中。

对于开发人员

推荐的开发工具

我强烈建议使用带有以下扩展的 VSCode：

• Prettier - Code formatter ：用于自动格式化
• Tailwind CSS Intellisense ：使用 Tailwind CSS 类进行自动完成和智能感知
• 并将"editor.formatOnSave": true添加到 VSCode settings.json以使用 Prettier 自动格式化

使用pnpm start时，Node.JS 服务器使用--inspect运行。这意味着您可以使用各种 Inspector Client 进行调试。

技术堆栈

堆栈的重要部分是：

• MongoDB 用于持久化
• Redis 用于 Websocket 的分布式消息传递。
• SolidJS 的交互性
• TailwindCSS 用于样式设置
• pnpm 用于依赖管理

开始

 # 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

此时，您应该能够在浏览器中访问 http://localhost:3001 以查看 UI。

您还可以尝试通过热重载访问前端：http://localhost:1234

推荐的开发工具

• Redux 开发工具
  • 前端应用程序状态连接到“Redux Dev Tools”Chrome 扩展。
• NodeJS 调试器
  • pnpm start脚本使用--inspect标志启动 NodeJS API
  • 使用 VSCode 中的默认启动任务附加 ( F5 )
  • 或者转到 url chrome://inspect使用调试器
• 使用Poetry进行 Python 依赖管理 - https://python-poetry.org/docs/cli
  • .model/bin/poetry [...args]

格式和类型检查

该项目使用 ESLint 进行 linting，使用 Prettier 强制执行代码样式，并使用 TypeScript 检查类型错误。打开 PR 时，请确保您不会通过运行以下命令在任何这些检查中引入任何新错误：

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

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

该项目使用 BrowserStack 进行测试。