feat(cli): add commands and menu (#22)

* fix(cli): disallow sending empty messages

* feat(cli): add command menu

* feat(cli): implement resuming conversations

* feat(cli): implement commands new, delete-all

* feat: add copy command

* fix: always show command hint before message input

* fix: rename command values for better future compability with autocomplete

* refactor: use inquirer-autocomplete-prompt to provide menu instead

* fix: check for active conversation before copy

Author: waylaidwanderer

bin/cli.js

@@ -1,12 +1,13 @@
 #!/usr/bin/env node
 import fs from 'fs';
 import { pathToFileURL } from 'url'
+import { KeyvFile } from 'keyv-file';
 import ChatGPTClient from '../src/ChatGPTClient.js';
 import boxen from 'boxen';
 import ora from 'ora';
 import clipboard from 'clipboardy';
 import inquirer from 'inquirer';
-import { KeyvFile } from 'keyv-file';
+import inquirerAutocompletePrompt from 'inquirer-autocomplete-prompt';
 
 const arg = process.argv.find((arg) => arg.startsWith('--settings'));
 let path;
@@ -41,26 +42,83 @@ if (settings.storageFilePath && !settings.cacheOptions.store) {
     }
 
     settings.cacheOptions.store = new KeyvFile({ filename: settings.storageFilePath });
-    // TODO: actually do something with this
 }
 
+let conversationId = null;
+let parentMessageId = null;
+
+const availableCommands = [
+    {
+        name: '!resume - Resume last conversation',
+        value: '!resume',
+    },
+    {
+        name: '!new - Start new conversation',
+        value: '!new',
+    },
+    {
+        name: '!copy - Copy conversation to clipboard',
+        value: '!copy',
+    },
+    {
+        name: '!delete-all - Delete all conversations',
+        value: '!delete-all',
+    },
+    {
+        name: '!exit - Exit ChatGPT CLI',
+        value: '!exit',
+    },
+];
+
+inquirer.registerPrompt('autocomplete', inquirerAutocompletePrompt);
+
 const chatGptClient = new ChatGPTClient(settings.openaiApiKey, settings.chatGptClient, settings.cacheOptions);
 
 console.log(boxen('ChatGPT CLI', { padding: 0.7, margin: 1, borderStyle: 'double', dimBorder: true }));
 
 await conversation();
 
-async function conversation(conversationId = null, parentMessageId = null) {
-    const { message } = await inquirer.prompt([
+async function conversation() {
+    console.log('Type "!" to access the command menu.');
+    const prompt = inquirer.prompt([
         {
-            type: 'input',
+            type: 'autocomplete',
             name: 'message',
             message: 'Write a message:',
+            searchText: '​',
+            emptyText: '​',
+            source: (answers, input) => {
+                return Promise.resolve(
+                    input ? availableCommands.filter((command) => command.value.startsWith(input)) : []
+                );
+            }
         },
     ]);
-    if (message === '!exit') {
-        return true;
+    // hiding the ugly autocomplete hint
+    prompt.ui.activePrompt.firstRender = false;
+    let { message } = await prompt;
+    message = message.trim();
+    if (!message) {
+        return conversation();
+    }
+    if (message.startsWith('!')) {
+        switch (message) {
+            case '!resume':
+                return resumeConversation();
+            case '!new':
+                return newConversation();
+            case '!copy':
+                return copyConversation();
+            case '!delete-all':
+                return deleteAllConversations();
+            case '!exit':
+                return true;
+        }
     }
+    return onMessage(message);
+}
+
+async function onMessage(message) {
     const chatGptLabel = settings.chatGptClient?.chatGptLabel || 'ChatGPT';
     const spinner = ora(`${chatGptLabel} is typing...`);
     spinner.prefixText = '\n';
@@ -71,10 +129,68 @@ async function conversation(conversationId = null, parentMessageId = null) {
         spinner.stop();
         conversationId = response.conversationId;
         parentMessageId = response.messageId;
+        await chatGptClient.conversationsCache.set('lastConversation', {
+            conversationId,
+            parentMessageId,
+        });
         console.log(boxen(response.response, { title: chatGptLabel, padding: 0.7, margin: 1, dimBorder: true }));
     } catch (error) {
         spinner.stop();
-        console.log(boxen(error?.json?.error?.message || error.body, { title: 'Error', padding: 0.7, margin: 1, borderColor: 'red' }));
+        logError(error?.json?.error?.message || error.body);
+    }
+    return conversation();
+}
+
+async function resumeConversation() {
+    ({ conversationId, parentMessageId } = (await chatGptClient.conversationsCache.get('lastConversation')) || {});
+    if (conversationId) {
+        logSuccess(`Resumed conversation ${conversationId}.`);
+    } else {
+        logWarning('No conversation to resume.');
+    }
+    return conversation();
+}
+
+async function newConversation() {
+    conversationId = null;
+    parentMessageId = null;
+    logSuccess('Started new conversation.');
+    return conversation();
+}
+
+async function deleteAllConversations() {
+    await chatGptClient.conversationsCache.clear();
+    logSuccess('Deleted all conversations.');
+    return conversation();
+}
+
+async function copyConversation() {
+    if (!conversationId) {
+        logWarning('No conversation to copy.');
+        return conversation();
+    }
+    const { messages } = await chatGptClient.conversationsCache.get(conversationId);
+    // get the last message ID
+    const lastMessageId = messages[messages.length - 1].id;
+    const orderedMessages = ChatGPTClient.getMessagesForConversation(messages, lastMessageId);
+    const conversationString = orderedMessages.map((message) => `#### ${message.role}:\n${message.message}`).join('\n\n');
+    try {
+        await clipboard.write(`${conversationString}\n\n----\nMade with ChatGPT CLI: <https://github.com/waylaidwanderer/node-chatgpt-api>`);
+        logSuccess('Copied conversation to clipboard.');
+    } catch (error) {
+        logError(error?.message || error);
     }
-    return conversation(conversationId, parentMessageId);
+    return conversation();
+}
+
+function logError(message) {
+    console.log(boxen(message, { title: 'Error', padding: 0.7, margin: 1, borderColor: 'red' }));
+}
+
+function logSuccess(message) {
+    console.log(boxen(message, { title: 'Success', padding: 0.7, margin: 1, borderColor: 'green' }));
+}
+
+function logWarning(message) {
+    console.log(boxen(message, { title: 'Warning', padding: 0.7, margin: 1, borderColor: 'yellow' }));
 }

package-lock.json

@@ -38,6 +38,7 @@
     "fastify": "^4.11.0",
     "gpt-3-encoder": "^1.1.4",
     "inquirer": "^9.1.4",
+    "inquirer-autocomplete-prompt": "^3.0.0",
     "keyv": "^4.5.2",
     "keyv-file": "^0.2.0",
     "node-fetch": "^3.3.0",