From 891dacf8edaefcd558dc4618b09af431a472443b Mon Sep 17 00:00:00 2001
From: Maciej Jastrzebski <mdjastrzebski@gmail.com>
Date: Tue, 2 Apr 2024 09:32:59 +0200
Subject: [PATCH] chore: tweak init output and docs (#43)

---
 README.md                           |  5 ++---
 src/commands/chat/prompt-options.ts |  2 +-
 src/commands/chat/ui/HelpOutput.tsx |  2 +-
 src/commands/init/ui/InitUi.tsx     | 11 +++--------
 website/docs/getting-started.md     |  5 ++---
 5 files changed, 9 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 7a7eb02..7444a5f 100644
--- a/README.md
+++ b/README.md
@@ -34,13 +34,12 @@ Learn about AI CLI config file [here](https://callstack.github.io/ai-cli/config-
 
 ## Usage
 
-Run `ai [query]` to start a conversation with AI assistant. You can put the question in the params.
+Run `ai` to start a chat with an AI assistant. You can put the question in the params.
 
 ```shell-session
 $ ai "Tell me a joke"
 me: Tell me a joke
 ai: Why don’t skeletons fight each other? They don’t have the guts.
-me: _
 ```
 
 ## CLI options
@@ -53,7 +52,7 @@ CLI options are passed when invoking the `ai` commend:
 - `--model [name]` (or `-m [name]`): select a model to use. This should be a model available for selected provider.
 - `--creative`: respond in a creative way
 - `--precise`: respond in a more accurate way
-- `--verbose` (or `-V`): enable verbose
+- `--verbose` (or `-V`): enable verbose output
 
 ## CLI commands
 
diff --git a/src/commands/chat/prompt-options.ts b/src/commands/chat/prompt-options.ts
index 1194f04..52518a5 100644
--- a/src/commands/chat/prompt-options.ts
+++ b/src/commands/chat/prompt-options.ts
@@ -57,6 +57,6 @@ export const promptOptions: Record<keyof PromptOptions, Options> = {
   'verbose': {
     alias: 'V',
     type: 'boolean',
-    describe: 'Verbose output',
+    describe: 'Enable verbose output',
   },
 };
diff --git a/src/commands/chat/ui/HelpOutput.tsx b/src/commands/chat/ui/HelpOutput.tsx
index e8054f3..5e89326 100644
--- a/src/commands/chat/ui/HelpOutput.tsx
+++ b/src/commands/chat/ui/HelpOutput.tsx
@@ -11,7 +11,7 @@ export function HelpOutput() {
         <Newline /> - /info: Show current provider, model, and system prompt
         <Newline /> - /forget: AI will forget previous messages
         <Newline /> - /save: Save in a text file in {CHATS_SAVE_DIRECTORY}
-        <Newline /> - /verbose: Toggle verbose-level output
+        <Newline /> - /verbose: Toggle verbose output
       </Text>
     </Box>
   );
diff --git a/src/commands/init/ui/InitUi.tsx b/src/commands/init/ui/InitUi.tsx
index 8f9a389..0db44ce 100644
--- a/src/commands/init/ui/InitUi.tsx
+++ b/src/commands/init/ui/InitUi.tsx
@@ -38,7 +38,7 @@ export function InitUi({ hasConfig }: InitUiProps) {
   return (
     <Box flexDirection="column">
       <Text color={colors.initPrompt} key="welcome">
-        Welcome to AI CLI.
+        Welcome to AI CLI!
         {!hasConfig ? " Let's set you up quickly." : null}
         <Newline />
       </Text>
@@ -108,16 +108,11 @@ export function InitUi({ hasConfig }: InitUiProps) {
           </Text>
           <Newline count={2} />
           <Text color={colors.initPrompt}>
-            For a single question and answer just pass a prompt as a param:
+            Run "ai" to start a chat with an AI assistant. You can put the initial question in the
+            params.
           </Text>
           <Newline />
           <Text>$ ai "Tell me a useful productivity hack"</Text>
-          <Newline count={2} />
-          <Text color={colors.initPrompt}>
-            For interactive session use "-i" (or "--interactive") option:
-          </Text>
-          <Newline />
-          <Text>$ ai -i "Tell me an interesting fact about JavaScript"</Text>
           <Newline />
           <ExitApp />
         </Text>
diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md
index bd6ce9b..aa83b21 100644
--- a/website/docs/getting-started.md
+++ b/website/docs/getting-started.md
@@ -39,13 +39,12 @@ Read more about the [configuration file](config-file) format and available optio
 
 ## Usage
 
-Run `ai [query]` to start a conversation with AI assistant. You can put the question in the params.
+Run `ai [query]` to start a chat with an AI assistant. You can put the question in the params.
 
 ```shell-session
 $ ai "Tell me a joke"
 me: Tell me a joke
 ai: Why don’t skeletons fight each other? They don’t have the guts.
-me: _
 ```
 
 ## CLI options
@@ -58,7 +57,7 @@ CLI options are passed when invoking the `ai` commend:
 - `--model [name]` (or `-m [name]`): select a model to use. This should be a model available for selected provider.
 - `--creative`: respond in a creative way
 - `--precise`: respond in a more accurate way
-- `--verbose` (or `-V`): enable verbose
+- `--verbose` (or `-V`): enable verbose output
 
 ## CLI commands