Librarian

Project Introduction

The docs folder contains competition-related documentation.

Core Features

Applicable Scenarios

graph LR
    A[Enterprise Projects] --> B[Dependency Upgrade]
    C[CI/CD Pipelines] --> B
    D[Project Migration] --> B
    B --> E[Librarian Fix]
    E --> F[Perfectly Compatible]
    
    style E fill:#ff6b6b,stroke:#fff,color:#fff
    style F fill:#4caf50,stroke:#fff,color:#fff

• Enterprise-level Maven Projects: Fixing compatibility issues for dependency version upgrades in large projects.
• CI/CD Integration: Automated error handling and fixing in continuous integration pipelines.
• Project Migration: Batch intelligent fixing of errors during large-scale project migrations.
• Quality Assurance: Improving code quality and clearing technical debt.

Fix Result of Librarian

System Architecture

Core Module Details

Architectural Advantages: Modular design, loosely coupled architecture, supports plug-in extensions. Each module can be independently tested and deployed, ensuring high system availability and maintainability.

Intelligent Workflow

graph TD
    A[Client Project] --> B[Compilation Error Analysis]
    B --> C[Broken API Detection]
    C --> D[Knowledge Base Query]
    D --> E[LLM Fix Generation]
    E --> F[Apply Code]
    F --> G[Result Report]
    
    %% Feedback Loop
    G -.->|Fix Failed| E
    G -.->|New Errors Found| B
    G -.->|New Issues Detected| C
    
    %% Style Definitions
    classDef inputNode fill:#e1f5fe,stroke:#01579b,stroke-width:3px,color:#000,font-weight:bold
    classDef processNode fill:#f3e5f5,stroke:#4a148c,stroke-width:3px,color:#000,font-weight:bold
    classDef aiNode fill:#fff3e0,stroke:#e65100,stroke-width:4px,color:#000,font-weight:bold
    classDef outputNode fill:#e8f5e8,stroke:#1b5e20,stroke-width:3px,color:#000,font-weight:bold
    classDef reportNode fill:#fce4ec,stroke:#880e4f,stroke-width:3px,color:#000,font-weight:bold
    
    %% Apply Styles
    class A inputNode
    class B,C,D processNode
    class E aiNode
    class F outputNode
    class G reportNode

Environment Requirements

Quick Start with Librarian

This guide will explain how to configure and run `Librarian`

Overview

graph LR
    A[Step 1: Download Library Artifacts] --> B[Step 2: Configure Librarian]
    B --> C[Step 3: Build & Run]
    
    style A fill:#e8f5e8,stroke:#4caf50,stroke-width:3px,color:#000,font-weight:bold
    style B fill:#fff3e0,stroke:#ff9800,stroke-width:3px,color:#000,font-weight:bold
    style C fill:#e3f2fd,stroke:#2196f3,stroke-width:3px,color:#000,font-weight:bold

Step 1: Download Library Artifacts

Before running Librarian, you need to download the artifacts of the target libraries.

public static void main(String[] args) {
    SingleLibraryKnowledgeCollector collector = new SingleLibraryKnowledgeCollector("org.locationtech.jts", "jts-core");
    collector.collect();
    log.info("✅ Collect Finish");
}

Step 2: Configure Librarian

After downloading the library artifacts, configure the CLI in librarian-cli-starter/src/main/resources/application.properties:

# Root directory of the library artifacts downloaded in Step 1
config.library-database-path=/path/to/your/library/database

# Output directory for the fixed project
config.fix-space-dir=/path/to/your/fix/output

# Your LLM API Key
config.llm.api-key=your-api-key

# LLM API Base URL
config.llm.base-url=https://api.example.com/v1

# LLM Model Name
config.llm.model-name=your-model-name

Step 3: Build & Run Librarian

Build `Librarian`

bash build.bash  # Compile and package

Build Artifact Location: librarian-cli-starter/target/strange-cli-1.0-SNAPSHOT.jar

java -jar strange-cli/target/strange-cli-1.0-SNAPSHOT.jar [-p [PROJECT_PATH]]

License

This project is licensed under the MIT License. See the LICENSE file for details.