Merge pull request #1 from shahabkondri/1.0.2

Merge 1.0.2

Author: shahabkondri

.github/workflows/release.yml

@@ -5,7 +5,36 @@ on:
       - 'v*'
 
 jobs:
+  jar_build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'adopt'
+          java-version: 17
+
+      - name: Cache Maven dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+
+      - name: Build JAR
+        run: ./mvnw clean package -DskipTests
+
+      - name: Upload JAR as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: chat-gpt-cli-jar
+          path: target/chat-gpt-cli-*.jar
+
   native_build:
+    needs: jar_build
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -68,6 +97,12 @@ jobs:
           draft: false
           prerelease: false
 
+      - name: Download JAR artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: chat-gpt-cli-jar
+          path: artifacts/chat-gpt-cli-jar
+
       - name: Download artifacts
         uses: actions/download-artifact@v3
         with:
@@ -80,12 +115,11 @@ jobs:
           name: chat-gpt-cli-linux64
           path: artifacts/chat-gpt-cli-linux64
 
-      - name: Upload native images
+      - name: Upload native images and JAR to the release
         run: |
-          for artifact_name in chat-gpt-cli-macos-intel chat-gpt-cli-linux64; do
-            echo "Uploading ${artifact_name}"
-            cp artifacts/${artifact_name}/chat-gpt-cli artifacts/${artifact_name}/${artifact_name}
-            gh release upload ${{ steps.extract_tag.outputs.tag }} artifacts/${artifact_name}/${artifact_name}
-          done
+          gh release upload ${{ steps.extract_tag.outputs.tag }} \
+            artifacts/chat-gpt-cli-jar/chat-gpt-cli-*.jar \
+            artifacts/chat-gpt-cli-macos-intel/chat-gpt-cli \
+            artifacts/chat-gpt-cli-linux64/chat-gpt-cli
         env:
-          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+          GITHUB_TOKEN: ${{ secrets.GH_PAT }}

README.md

@@ -0,0 +1,72 @@
+# ChatGPT CLI
+ChatGPT CLI is a command-line interface for interacting with the ChatGPT API, built with Java, Spring Boot, and Spring Shell. It is a simple and easy-to-use tool that allows users to send messages and receive AI-generated responses.
+
+## Features
+- Customizable terminal prompt
+- Spring Shell-based application for an enhanced command-line experience
+
+## Prerequisites
+
+- Java 17
+- Maven (Optional)
+
+## Configuration
+Before running the application, make sure to set the required configuration values:
+
+- `openai.api-key`: Set this to your OpenAI API key.
+- `chat.gpt.model`: Set this to the desired GPT model (e.g., `gpt_3_5_turbo`).
+
+You can set these values in the `application.properties` file or as environment variables.
+
+## How to Build and Run
+Clone the repository:
+
+```bash
+git clone https://github.com/shahabkondri/chat-gpt-cli.git
+cd chat-gpt-cli
+```
+
+To build the project, run:
+
+```bash
+./mvnw clean package
+```
+
+To run the application:
+
+```bash
+java -jar target/chat-gpt-cli-1.0.2.jar
+```
+
+## Native Build
+Native builds offer faster startup times, lower memory footprint, and easier distribution. To create a native build, install GraalVM and use it as your JDK. Then, run the following command:
+
+```bash
+./mvnw clean -Pnative native:compile
+```
+
+This will produce a standalone executable optimized for your platform.
+Once compiled, you can run the native executable:
+
+```bash
+./target/chat-gpt-cli
+```
+
+## Usage
+After starting the application, you will see a terminal prompt:
+
+```bash
+:> 
+```
+
+Enter your message and press Enter to send it to the ChatGPT API. The AI-generated response will be displayed in the terminal. To exit the application, type exit and press Enter.
+
+```bash
+:> chat tell me a joke.
+```
+
+## License
+This project is licensed under the MIT License. See the [LICENCE](LICENCE.md) file for details.
+
+## Contributing
+Feel free to submit issues and enhancement requests on the GitHub issue tracker.

pom.xml

@@ -11,7 +11,7 @@
 
 	<groupId>com.shahabkondri</groupId>
 	<artifactId>chat-gpt-cli</artifactId>
-	<version>1.0.2-SNAPSHOT</version>
+	<version>1.0.2</version>
 	<packaging>jar</packaging>
 
 	<name>chat-gpt-cli</name>
@@ -48,6 +48,8 @@
 		<java.version>17</java.version>
 		<spring-shell.version>3.0.1</spring-shell.version>
 
+		<maven-source-plugin.version>3.2.1</maven-source-plugin.version>
+		<maven-javadoc-plugin.version>3.5.0</maven-javadoc-plugin.version>
 		<spring-javaformat-maven-plugin.version>0.0.35</spring-javaformat-maven-plugin.version>
 		<maven-checkstyle-plugin.version>3.2.1</maven-checkstyle-plugin.version>
 		<checkstyle.version>10.7.0</checkstyle.version>
@@ -69,7 +71,7 @@
 		<dependency>
 			<groupId>com.shahabkondri</groupId>
 			<artifactId>chat-gpt-api</artifactId>
-			<version>1.0.1</version>
+			<version>1.0.2</version>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.shell</groupId>
@@ -88,6 +90,32 @@
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-maven-plugin</artifactId>
 			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<version>${maven-javadoc-plugin.version}</version>
+				<executions>
+					<execution>
+						<id>attach-javadoc</id>
+						<goals>
+							<goal>jar</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-source-plugin</artifactId>
+				<version>${maven-source-plugin.version}</version>
+				<executions>
+					<execution>
+						<id>attach-sources</id>
+						<goals>
+							<goal>jar</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
 			<plugin>
 				<groupId>io.spring.javaformat</groupId>
 				<artifactId>spring-javaformat-maven-plugin</artifactId>

src/main/java/com/shahabkondri/chatgpt/cli/ChatGptCliApplication.java

@@ -1,18 +1,35 @@
 package com.shahabkondri.chatgpt.cli;
 
+import org.springframework.boot.Banner;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
+import org.springframework.context.ConfigurableApplicationContext;
+
+import java.util.Map;
 
 /**
+ * The main entry point of the ChatGPT CLI application. This class configures and starts
+ * the Spring Boot application, disabling the banner, setting a random server port, and
+ * scanning for configuration properties from the specified property source.
+ *
  * @author Shahab Kondri
  */
 @SpringBootApplication
 @ConfigurationPropertiesScan
 public class ChatGptCliApplication {
 
+	/**
+	 * The main method that starts the ChatGPT CLI application, configuring and launching
+	 * the Spring Boot application with the specified command line arguments.
+	 * @param args The command line arguments passed to the application.
+	 */
 	public static void main(String[] args) {
-		SpringApplication.exit(SpringApplication.run(ChatGptCliApplication.class, args));
+		SpringApplication app = new SpringApplication(ChatGptCliApplication.class);
+		app.setBannerMode(Banner.Mode.OFF);
+		app.setDefaultProperties(Map.of("server.port", "0"));
+		ConfigurableApplicationContext context = app.run(args);
+		SpringApplication.exit(context);
 	}
 
 }

src/main/java/com/shahabkondri/chatgpt/cli/command/ChatGptCommand.java

@@ -4,15 +4,28 @@
 import com.shahabkondri.chatgpt.api.model.ChatGptRequest;
 import com.shahabkondri.chatgpt.api.model.MessageRole;
 import com.shahabkondri.chatgpt.cli.configuration.ChatGptProperties;
-import org.springframework.core.codec.DecodingException;
+import com.shahabkondri.chatgpt.cli.shell.Spinner;
+import com.shahabkondri.chatgpt.cli.shell.TerminalPrinter;
 import org.springframework.shell.standard.ShellComponent;
 import org.springframework.shell.standard.ShellMethod;
 import org.springframework.shell.standard.ShellOption;
+import reactor.core.publisher.SignalType;
+import reactor.core.scheduler.Schedulers;
 
+import java.time.Duration;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 /**
+ * A {@link ShellComponent} that facilitates user interaction with ChatGPT through the
+ * terminal. Offers commands for sending messages to the API, processing AI-generated
+ * responses as a stream, and managing chat history. Streamlines the process of obtaining
+ * and displaying AI-generated responses in real-time.
+ *
  * @author Shahab Kondri
  */
 @ShellComponent
@@ -22,38 +35,100 @@ public class ChatGptCommand {
 
 	private final TerminalPrinter terminalPrinter;
 
+	private final ChatGptProperties chatGptProperties;
+
+	private final Spinner spinner;
+
 	private final List<ChatGptRequest.Message> messages = new CopyOnWriteArrayList<>();
 
-	private final ChatGptProperties chatGptProperties;
+	private static final Pattern NEW_LINE_PATTERN = Pattern.compile("\n\n");
+
+	private static final Duration CHAT_TIMEOUT = Duration.ofSeconds(30);
 
+	/**
+	 * Constructs a new ChatGptCommand with the specified client, printer, properties, and
+	 * spinner.
+	 * @param chatGptClient The ChatGPT client for interacting with the API.
+	 * @param terminalPrinter The terminal printer for printing messages.
+	 * @param chatGptProperties The properties for the ChatGPT API.
+	 * @param spinner The spinner for showing loading state.
+	 */
 	public ChatGptCommand(ChatGptClient chatGptClient, TerminalPrinter terminalPrinter,
-			ChatGptProperties chatGptProperties) {
+			ChatGptProperties chatGptProperties, Spinner spinner) {
 		this.chatGptClient = chatGptClient;
 		this.terminalPrinter = terminalPrinter;
 		this.chatGptProperties = chatGptProperties;
+		this.spinner = spinner;
 	}
 
-	@ShellMethod(key = "chat", value = "sends a message to a ChatGPT API client and returns the response.")
-	public void chat(@ShellOption ChatGptRequest.Message message) {
-		messages.add(message);
-
-		ChatGptRequest request = new ChatGptRequest(chatGptProperties.getModel(), messages);
+	/**
+	 * Interacts with the ChatGPT API by sending a user message and processing the
+	 * AI-generated response as a stream. To use this command in the terminal, type 'chat'
+	 * or 'c', followed by your message. For example: <pre>
+	 * :> chat Hello ChatGPT, can you help me with my question?
+	 * </pre> or <pre>
+	 * :> c Hello ChatGPT, can you help me with my question?
+	 * </pre>
+	 * @param prompt The user input to send to the ChatGPT API.
+	 */
+	@ShellMethod(key = { "chat", "c" }, value = "Interacts with the ChatGPT API by sending a"
+			+ " user message and processing the AI-generated response as a stream")
+	public void chat(@ShellOption(arity = Integer.MAX_VALUE) String... prompt) {
+		spinner.startSpinner();
+		String message = String.join(" ", prompt);
+		messages.add(new ChatGptRequest.Message(MessageRole.USER, message));
+		ChatGptRequest request = new ChatGptRequest(chatGptProperties.model(), messages);
 
+		AtomicBoolean isFirstResultPrinted = new AtomicBoolean(false);
 		StringBuilder builder = new StringBuilder();
+		CountDownLatch latch = new CountDownLatch(1);
+
 		chatGptClient.completions(request).filter(response -> response.choices().get(0).delta().content() != null)
-				.map(response -> response.choices().get(0).delta().content()).doOnNext(response -> {
-					terminalPrinter.print(response);
-					builder.append(response);
-				}).onErrorContinue((error, o) -> {
-					if (error instanceof DecodingException && o.toString().contains("[DONE]")) {
+				.doOnNext(__ -> spinner.stopSpinner())
+				.map(response -> normalizeOutput(response.choices().get(0).delta().content(), isFirstResultPrinted))
+				.doOnNext(builder::append).publishOn(Schedulers.parallel()).timeout(CHAT_TIMEOUT).doFinally(signal -> {
+					terminalPrinter.newLine();
+					ChatGptRequest.Message assistantMessage = new ChatGptRequest.Message(MessageRole.ASSISTANT,
+							builder.toString());
+					messages.add(assistantMessage);
+					latch.countDown();
+
+					// Stop the spinner if the timeout occurred
+					if (signal == SignalType.ON_ERROR && latch.getCount() == 0) {
+						spinner.stopSpinner();
+						terminalPrinter.print("Oops, something went wrong. Please try again.");
 						terminalPrinter.newLine();
 					}
-				}).collectList().block();
+				}).subscribe(terminalPrinter::print);
+		try {
+			latch.await();
+		}
+		catch (InterruptedException e) {
+			Thread.currentThread().interrupt();
+		}
+	}
 
-		ChatGptRequest.Message assistantMessage = new ChatGptRequest.Message(MessageRole.ASSISTANT, builder.toString());
-		messages.add(assistantMessage);
+	/**
+	 * Normalizes the output generated by the ChatGPT API, removing unnecessary new lines.
+	 * @param output The output generated by the ChatGPT API.
+	 * @param isFirstResultPrinted An atomic boolean flag to check if this is the first
+	 * result printed.
+	 * @return The normalized output string.
+	 */
+	private static String normalizeOutput(String output, AtomicBoolean isFirstResultPrinted) {
+		Matcher matcher = NEW_LINE_PATTERN.matcher(output);
+		if (matcher.matches()) {
+			if (!isFirstResultPrinted.getAndSet(true)) {
+				return matcher.replaceAll("");
+			}
+			return matcher.replaceAll("\n");
+		}
+		return output;
 	}
 
+	/**
+	 * Clears the chat history by removing all messages from the messages list.
+	 */
 	@ShellMethod(key = "chat --clear", value = "Clear chat history.")
 	public void clearChat() {
 		messages.clear();