Skip to content

wiki doc

rainsfly edited this page Mar 12, 2026 · 1 revision
This project, "Xianyu Intelligent Monitor Bot", is designed to monitor and interact with Xianyu (a second-hand trading platform) using AI-driven task creation and management.

## Core Features

* **AI-Driven Task Creation**: Automatically generates task requirements based on descriptions.
* **Multi-Account Management**: Supports managing multiple Xianyu accounts.
* **Proxy Support**: Integrates proxy rotation for requests.
* **Docker Deployment**: Recommended deployment method for ease of setup using Docker Compose.
* **Web UI**: Provides a user-friendly web interface for task management, account binding, and viewing logs/results.
* **Task Scheduling**: Allows scheduling of monitoring tasks.
* **Result Notifications**: Can send notifications about task results.
* **Data Storage**: Uses SQLite for primary storage, with options for data migration.

## Deployment

The recommended way to deploy is using Docker:

1.  Clone the repository: `git clone https://github.com/Usagi-org/ai-goofish-monitor && cd ai-goofish-monitor`
2.  Copy and configure the environment file: `cp .env.example .env` (then edit `.env`)
3.  Build and run with Docker Compose: `docker compose up -d`

Local startup scripts are also available but Docker is preferred.

## Basic Usage

1.  Access the Web UI (default port 8000).
2.  Log in and set up your Xianyu accounts via the "Account Management" section, including providing login state JSON.
3.  Create tasks using the "Task Management" section, either with AI mode or keyword mode.
4.  Bind accounts to tasks.
5.  Monitor task progress and results through the UI.

Clone this wiki locally