Spring AI Alibaba Lynxe

🌍 English | 中文

📚 Developer Docs: Quick Start (EN) | 开发者快速入门 (中文)

About • Quick Start • Contributing

---

✨ About Lynxe(Original name: JManus）

Lynxe is a Java implementation of Manus, currently used in many applications within Alibaba Group. It is primarily used for handling exploratory tasks that require a certain degree of determinism, such as quickly finding data from massive datasets and converting it into a single row in a database, or analyzing logs and issuing alerts.

Lynxe also provides HTTP service invocation capabilities, making it suitable for integration into existing projects. For details, please refer to the developer quick start guide.

🎯 Lynxe Product Features

🤖 Pure Java Manus Implementation:

A pure Java multi-agent collaboration implementation that provides a complete set of HTTP call interfaces, suitable for secondary integration by Java developers.

🛠️ Func-Agent Mode:

Allows you to precisely control every execution detail, providing extremely high execution determinism and completing complex repetitive processes and functions. For specific examples, see Lynxe Use Cases - FuncAgent Use Case

🔗 MCP Integration:

Natively supports the Model Context Protocol (MCP) for seamless integration with external services and tools.

🚀 Quick Start

Get Lynxe up and running in under 5 minutes:

Prerequisites

• 🌐 DashScope API Key (or alternative AI model provider)
• ☕ Java 17+ (for running JAR files or source code execution) or 🐳 Docker (for containerized deployment)

Method 1: Using GitHub Release (Recommended)

📦 Download and Run JAR File

# Download the latest JAR file
wget https://github.com/spring-ai-alibaba/Lynxe/releases/latest/download/lynxe.jar

# Or using curl
curl -L -o lynxe.jar https://github.com/spring-ai-alibaba/Lynxe/releases/latest/download/lynxe.jar

# Run the JAR file
java -jar lynxe.jar

💡 Manual Download: You can also visit the Lynxe Releases page to manually download the latest JAR file.

🌐 Access Application

After the application starts, navigate to http://localhost:18080 in your browser.

💡 Guided Setup: After the application starts, it will automatically display a guided setup page. On the first page, select your language (English/Chinese), then on the second page, enter your DashScope API key that you just obtained to complete the configuration.

🎉 Congratulations! Your multi-agent system has been quickly started. You can visit https://github.com/talk-flow/public-usecase to explore some effective practices we recommend.

---

Method 2: Using Docker (Recommended for Production)

🐳 Pull and Run Docker Image

# Pull the latest Lynxe Docker image
docker pull ghcr.io/spring-ai-alibaba/lynxe:v4.7.0

# Run the container
docker run -d \
  --name lynxe \
  -p 18080:18080 \
  ghcr.io/spring-ai-alibaba/lynxe:v4.7.0

🔧 Advanced Docker Configuration

Run with data persistence (recommended for production):

# Create a directory for data persistence
mkdir -p ./lynxe-data

# Run with volume mounting
docker run -d \
  --name lynxe \
  -p 18080:18080 \
  -v $(pwd)/lynxe-data:/app/data \
  ghcr.io/spring-ai-alibaba/lynxe:v4.7.0

Run with custom environment variables:

docker run -d \
  --name lynxe \
  -p 18080:18080 \
  -e SPRING_PROFILES_ACTIVE=mysql \
  -e SPRING_DATASOURCE_URL=jdbc:mysql://host.docker.internal:3306/lynxe \
  -e SPRING_DATASOURCE_USERNAME=your_username \
  -e SPRING_DATASOURCE_PASSWORD=your_password \
  ghcr.io/spring-ai-alibaba/lynxe:v4.7.0

🌐 Access Application

After the container starts, navigate to http://localhost:18080 in your browser.

💡 Guided Setup: After the application starts, it will automatically display a guided setup page. On the first page, select your language (English/Chinese), then on the second page, enter your DashScope API key that you just obtained to complete the configuration.

📋 Useful Docker Commands

# View container logs
docker logs -f lynxe

# Stop the container
docker stop lynxe

# Start the container
docker start lynxe

# Remove the container
docker rm lynxe

🎉 Congratulations! Your multi-agent system is now running in Docker. You can visit https://github.com/talk-flow/public-usecase to explore some effective practices we recommend.

---

Method 3: Running from Source Code (Alternative)

1. Clone and Navigate

git clone https://github.com/spring-ai-alibaba/Lynxe.git
cd Lynxe

2. Database Configuration (Optional)

💡 Get your DashScope API Key: Visit Alibaba Cloud Console to obtain your free API key.

Using other providers? Update the configuration in src/main/resources/application.yml to use your preferred AI model platform.

Lynxe supports both H2 (default)、MySQL and PostgreSQL databases.

How To Use MySQL/PostgreSQL

1. Configure Database Connection: Update the database configuration and JPA database-platform in the application-mysql.yml/application-postgres.yml under 'src/main/resources/':

   spring:
     datasource:
       url: your_url
       username: your_username
       password: your_password
     jpa:
       database-platform: org.hibernate.dialect.MySQLDialect/PostgreSQLDialect

2. Activate MySQL/PostgreSQL Profile: Update configuration in src/main/resources/application.yml:

   spring:
     ...
     profiles:
       active: mysql/postgres

💡 Note: The application will automatically create required tables on first startup using JPA's ddl-auto: update configuration.

3. Launch the Application

For Unix-like systems (macOS, Linux):

../mvnw spring-boot:run

For Windows systems:

../mvnw.cmd spring-boot:run

4. Access Your Multi-Agent Dashboard

Navigate to http://localhost:18080 in your browser.

🎉 Congratulations! Your multi-agent system is now live and ready for action. You can visit https://github.com/talk-flow/public-usecase to explore some effective practices we recommend.

Stable Release

you can find stable release from here: release

🤝 Contributing

We enthusiastically welcome contributions from the developer community! Here's how you can make an impact:

Contribution Opportunities

You can find available tasks on our project board.

• 🐛 Bug Reports: Submit detailed issue reports
• 💡 Feature Requests: Propose innovative enhancements
• 📝 Documentation: Help us improve clarity and completeness
• 🔧 Code Contributions: Submit pull requests with your improvements

Development Environment Setup

# Fork and clone the repository
git clone [email protected]:spring-ai-alibaba/Lynxe.git
cd Lynxe

# Install project dependencies
mvn clean install

# Apply code formatting standards
mvn spotless:apply

# Start the development server
mvn spring-boot:run

Development Guidelines

• Follow existing code style and conventions
• Write comprehensive tests for new features
• Update documentation for any API changes
• Ensure all tests pass before submitting PRs

---

交流讨论

点击这个链接加入钉钉群讨论：钉群链接

Crafted with ❤️ by the Spring AI Alibaba Team

⭐ Star us on GitHub if Lynxe accelerated your development journey!