opencli-spring-boot-starter

Spring Boot Starter for opencli

简体中文 | English

Positioning · Capabilities · Dependency · Quick Start · Configuration · Versions · Build · License

---

Current Version：3.5.x.20260630-SNAPSHOT
JDK Baseline：17
Group ID：io.github.easy4j
Artifact ID：opencli-spring-boot-starter
License：Apache License 2.0

1. Positioning

opencli-spring-boot-starter is a Spring Boot starter that integrates opencli for applications using opencli. It provides auto-configuration, property binding, and ready-to-use beans so that applications can consume opencli capabilities with minimal setup.

Dimension	Description
Type	Spring Boot Starter
Consumers	Spring Boot applications using opencli
Core Capabilities	auto-configuration, property binding, ready-to-use beans for opencli
JDK	17
Coordinates	io.github.easy4j:opencli-spring-boot-starter:3.5.x.20260630-SNAPSHOT
Config Prefix	opencli

2. Core Capabilities

Capability	Status	Description
Auto-configuration	✅ Stable	Registers opencli beans automatically
Property Binding	✅ Stable	Binds opencli.* to OpenCliCenterWsProperties
OpenCliExecutor bean	✅ Stable	Auto-registered via OpenCliAutoConfiguration

3. Requirements and Compatibility

Dependency	Minimum	Evidence
JDK	17	pom.xml
Spring Boot	3.5.9	pom.xml parent
Maven	3.6+	Maven Enforcer

4. Auto-configuration

The starter auto-configures the following beans:

Bean	Condition	Missing Behavior
OpenCliExecutor	classpath + property	not created
OpenCliClient	classpath + property	not created
OpenCliAvailabilityChecker	classpath + property	not created
OpenCliCliStartupChecker	classpath + property	not created
OpenCliWsReverseAgentClient	classpath + property	not created
OpenCliMetaClient	classpath + property	not created
OpenCliBrowserClient	classpath + property	not created
CodexOpenCliClient	classpath + property	not created
CursorOpenCliClient	classpath + property	not created
ClaudeOpenCliClient	classpath + property	not created
ChatgptOpenCliClient	classpath + property	not created
GeminiOpenCliClient	classpath + property	not created
JimengOpenCliClient	classpath + property	not created
NpmOpenCliClient	classpath + property	not created
ArxivOpenCliClient	classpath + property	not created
WikipediaOpenCliClient	classpath + property	not created
BinanceOpenCliClient	classpath + property	not created

Auto-configuration registration:

• META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports (Spring Boot 2.7+ / 3.x / 4.x)
• META-INF/spring.factories (Spring Boot 2.x legacy)

5. Dependency

<dependency>
    <groupId>io.github.easy4j</groupId>
    <artifactId>opencli-spring-boot-starter</artifactId>
    <version>3.5.x.20260630-SNAPSHOT</version>
</dependency>

This starter depends on the following components (managed by ddd4j BOM):

<dependency>
    <groupId>io.github.easy4j</groupId>
    <artifactId>opencli-java-sdk</artifactId>
</dependency>

6. Quick Start

6.1 Add dependency

Add the dependency above to your pom.xml.

6.2 Configure

opencli:
  enabled: true

6.3 Use the bean

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Then inject the auto-configured bean in your code:

@Autowired
private OpenCliExecutor openCliExecutor;

7. Configuration Reference

7.1 Config Prefix

opencli

7.2 Configuration Items

Property	Type	Default	Required	Description	Sensitive
opencli.enabled	boolean	true	No	Enable the starter	No

8. Version Lines and Compatibility

Branch	JDK	Spring Boot	Component Version	Status
2.3.x / 2.7.x	8+	2.3.x / 2.7.x	1.0.x	Maintenance
3.0.x ~ 3.5.x	17	3.x	2.0.x	Maintenance
4.0.x / 4.1.x	17+	4.x	3.0.x	Active

9. Build and Test

mvn clean verify
mvn -pl opencli-spring-boot-starter -am test

10. Troubleshooting

Symptom	Diagnosis	Resolution
Bean not created	Check auto-configuration report	Verify opencli.enabled=true and classpath
ClassNotFoundException	Missing dependency	Add the required module
Version conflict	mvn dependency:tree	Use BOM for version alignment

11. Contribution

1. Fork the repository.
2. Create a feature branch.
3. Run mvn clean verify before submitting.
4. Submit a pull request.

12. License

This project is licensed under the Apache License, Version 2.0.

---

Back to top · Issues · Repository