chore(release): 1.28.2

## [1.28.2](v1.28.1...v1.28.2) (2024-07-03)
rpidanny · Jul 3, 2024 · 8ec4f7d · 8ec4f7d
1 parent 64cea66
commit 8ec4f7d
Show file tree

Hide file tree

Showing 8 changed files with 72 additions and 84 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,5 @@
+## [1.28.2](https://github.com/rpidanny/darwin/compare/v1.28.1...v1.28.2) (2024-07-03)
+
 ## [1.28.1](https://github.com/rpidanny/darwin/compare/v1.28.0...v1.28.1) (2024-07-03)
 
 ## [1.28.0](https://github.com/rpidanny/darwin/compare/v1.27.0...v1.28.0) (2024-07-03)

diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ $ npm install -g @rpidanny/darwin
 $ darwin COMMAND
 running command...
 $ darwin (--version)
-@rpidanny/darwin/1.28.1 linux-x64 node-v20.15.0
+@rpidanny/darwin/1.28.2 linux-x64 node-v20.15.0
 $ darwin --help [COMMAND]
 USAGE
   $ darwin COMMAND
@@ -44,7 +44,7 @@ USAGE
 <!-- commands -->
 # Command Topics
 
-* [`darwin chat`](docs/chat.md) - Chat with Darwin. Can be used to instruct Darwin to do things in natural language.
+* [`darwin chat`](docs/chat.md) - Chat with Darwin using natural language.
 * [`darwin config`](docs/config.md) - Manage application configurations.
 * [`darwin download`](docs/download.md) - Download papers, datasets, or other content.
 * [`darwin search`](docs/search.md) - Search for papers, accession numbers, or other content.

diff --git a/docs/chat.md b/docs/chat.md
@@ -1,35 +1,30 @@
 `darwin chat`
 =============
 
-Chat with Darwin. Can be used to instruct Darwin to do things in natural language.
+Chat with Darwin using natural language.
 
 * [`darwin chat`](#darwin-chat)
 
 ## `darwin chat`
 
-Chat with Darwin. Can be used to instruct Darwin to do things in natural language.
+Chat with Darwin using natural language.
 
 ```
 USAGE
-  $ darwin chat [--log-level TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-p <value>] [-l] [-s]
-    [--legacy-processing] [--llm-provider openai|ollama]
+  $ darwin chat [-l TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-p NUMBER] [-s] [--legacy] [--llm openai|ollama]
 
 FLAGS
-  -l, --logs                   Include application logs along with the chat conversations.
-  -p, --concurrency=<value>    [default: 10] The number papers to process in parallel.
-  -s, --skip-captcha           Skip captcha on paper URLs. Note: Google Scholar captcha still needs to be solved.
-      --legacy-processing      Enable legacy processing of papers that only extracts text from the main URL. The new
-                               method attempts to extract text from the source URLs (pdf or html) and falls back to the
-                               main URL.
-      --llm-provider=<option>  [default: ollama] The LLM provider to use for generating summaries.
-                               <options: openai|ollama>
+  -p, --concurrency=NUMBER  [default: 10] The number papers to process in parallel.
+  -s, --skip-captcha        Skip captcha on paper URLs. Note: Google Scholar captcha still needs to be solved.
+      --legacy              Enable legacy processing which extracts text only from the main URL. The new method attempts
+                            to extract text from the source URLs (pdf or html) and falls back to the main URL.
+      --llm=openai|ollama   [default: ollama] The LLM provider to use for generating summaries.
 
 GLOBAL FLAGS
-  --log-level=<option>  [default: INFO] Specify level for logging.
-                        <options: TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
+  -l, --log-level=TRACE|DEBUG|INFO|WARN|ERROR|FATAL  [default: INFO] Specify logging level.
 
 EXAMPLES
   $ darwin chat
 ```
 
-_See code: [src/commands/chat/index.ts](https://github.com/rpidanny/darwin/blob/v1.28.1/src/commands/chat/index.ts)_
+_See code: [src/commands/chat/index.ts](https://github.com/rpidanny/darwin/blob/v1.28.2/src/commands/chat/index.ts)_
diff --git a/docs/config.md b/docs/config.md
@@ -12,11 +12,10 @@ Get currently set config
 
 ```
 USAGE
-  $ darwin config get [--log-level TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
+  $ darwin config get [-l TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
 
 GLOBAL FLAGS
-  --log-level=<option>  [default: INFO] Specify level for logging.
-                        <options: TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
+  -l, --log-level=TRACE|DEBUG|INFO|WARN|ERROR|FATAL  [default: INFO] Specify logging level.
 
 DESCRIPTION
   Get currently set config
@@ -25,7 +24,7 @@ EXAMPLES
   $ darwin config get
 ```
 
-_See code: [src/commands/config/get.ts](https://github.com/rpidanny/darwin/blob/v1.28.1/src/commands/config/get.ts)_
+_See code: [src/commands/config/get.ts](https://github.com/rpidanny/darwin/blob/v1.28.2/src/commands/config/get.ts)_
 
 ## `darwin config set`
 
@@ -42,4 +41,4 @@ EXAMPLES
   $ darwin config set
 ```
 
-_See code: [src/commands/config/set.ts](https://github.com/rpidanny/darwin/blob/v1.28.1/src/commands/config/set.ts)_
+_See code: [src/commands/config/set.ts](https://github.com/rpidanny/darwin/blob/v1.28.2/src/commands/config/set.ts)_
diff --git a/docs/download.md b/docs/download.md
@@ -11,25 +11,24 @@ Download PDF papers based on specified keywords.
 
 ```
 USAGE
-  $ darwin download papers KEYWORDS -o <value> [--log-level TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-c <value>] [-h]
+  $ darwin download papers KEYWORDS -o <value> [-l TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-c NUMBER] [-h]
 
 ARGUMENTS
-  KEYWORDS  The keywords to search for
+  KEYWORDS  The keywords to search for. (Example: "crispr cas9")
 
 FLAGS
-  -c, --count=<value>   [default: 10] The minimum number of papers to search for. (When running concurrently, the actual
-                        number of papers may be a bit higher)
+  -c, --count=NUMBER    [default: 10] Minimum number of papers to search for. Actual number may be slightly higher with
+                        concurrency.
   -h, --headless        Run the browser in headless mode (no UI).
   -o, --output=<value>  (required) The path to save the downloaded papers.
 
 GLOBAL FLAGS
-  --log-level=<option>  [default: INFO] Specify level for logging.
-                        <options: TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
+  -l, --log-level=TRACE|DEBUG|INFO|WARN|ERROR|FATAL  [default: INFO] Specify logging level.
 
 EXAMPLES
   $ darwin download papers --help
 
-  $ darwin download papers "crispr cas9" -o papers/ -c 100 --log-level debug
+  $ darwin download papers "crispr cas9" --output papers/ --count 100 --log-level debug
 ```
 
-_See code: [src/commands/download/papers.ts](https://github.com/rpidanny/darwin/blob/v1.28.1/src/commands/download/papers.ts)_
+_See code: [src/commands/download/papers.ts](https://github.com/rpidanny/darwin/blob/v1.28.2/src/commands/download/papers.ts)_
diff --git a/docs/search.md b/docs/search.md
@@ -12,92 +12,85 @@ Search and export papers containing accession numbers to a CSV file.
 
 ```
 USAGE
-  $ darwin search accession KEYWORDS [--log-level TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-c <value>] [-p <value>] [-o
-    <value>] [-a <value>] [-s] [--legacy-processing] [-h] [-S] [--llm-provider openai|ollama]
+  $ darwin search accession KEYWORDS [-l TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-c NUMBER] [-p NUMBER] [-o PATH] [-a
+    REGEX] [-s] [--legacy] [-h] [-S] [--llm openai|ollama]
 
 ARGUMENTS
-  KEYWORDS  The keywords to search for
+  KEYWORDS  The keywords to search for. (Example: "crispr cas9")
 
 FLAGS
-  -S, --include-summary                 [LLM Required] Include the paper summary in the output CSV file. When enabled,
-                                        concurrency is set to 1.
-  -a, --accession-number-regex=<value>  [default: PRJNA\d+] Regex to match accession numbers. Defaults to matching
-                                        BioProject accession numbers.
-  -c, --count=<value>                   [default: 10] The minimum number of papers to search for. (When running
-                                        concurrently, the actual number of papers may be a bit higher)
-  -h, --headless                        Run the browser in headless mode (no UI).
-  -o, --output=<value>                  [default: .] Specify the output destination for the CSV file. If a folder path
-                                        is given, the filename is auto-generated; if a file path is given, it is used
-                                        directly.
-  -p, --concurrency=<value>             [default: 10] The number papers to process in parallel.
-  -s, --skip-captcha                    Skip captcha on paper URLs. Note: Google Scholar captcha still needs to be
-                                        solved.
-      --legacy-processing               Enable legacy processing of papers that only extracts text from the main URL.
-                                        The new method attempts to extract text from the source URLs (pdf or html) and
-                                        falls back to the main URL.
-      --llm-provider=<option>           [default: ollama] The LLM provider to use for generating summaries.
-                                        <options: openai|ollama>
+  -S, --summary                       Include summaries in the output CSV (requires LLM, sets concurrency to 1)
+  -a, --accession-number-regex=REGEX  [default: PRJNA\d+] Regex to match accession numbers. Defaults to matching
+                                      BioProject accession numbers.
+  -c, --count=NUMBER                  [default: 10] Minimum number of papers to search for. Actual number may be
+                                      slightly higher with concurrency.
+  -h, --headless                      Run the browser in headless mode (no UI).
+  -o, --output=PATH                   [default: .] Destination for the CSV file. Specify folder path for auto-generated
+                                      filename or file path for direct use.
+  -p, --concurrency=NUMBER            [default: 10] The number papers to process in parallel.
+  -s, --skip-captcha                  Skip captcha on paper URLs. Note: Google Scholar captcha still needs to be solved.
+      --legacy                        Enable legacy processing which extracts text only from the main URL. The new
+                                      method attempts to extract text from the source URLs (pdf or html) and falls back
+                                      to the main URL.
+      --llm=openai|ollama             [default: ollama] The LLM provider to use for generating summaries.
 
 GLOBAL FLAGS
-  --log-level=<option>  [default: INFO] Specify level for logging.
-                        <options: TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
+  -l, --log-level=TRACE|DEBUG|INFO|WARN|ERROR|FATAL  [default: INFO] Specify logging level.
 
 EXAMPLES
   $ darwin search accession --help
 
-  $ darwin search accession "mocrobiome, nRNA" -o output.csv  -n 5 -c 1 --log-level DEBUG
+  $ darwin search accession "mocrobiome, nRNA" --output ./ --count 10 --log-level DEBUG
 
 FLAG DESCRIPTIONS
-  -S, --include-summary
+  -S, --summary  Include summaries in the output CSV (requires LLM, sets concurrency to 1)
 
-    [LLM Required] Include the paper summary in the output CSV file. When enabled, concurrency is set to 1.
-
-    Summaries are generated using LLM so make sure LLMs are configured by running `darwin config set`
+    Summaries are generated using LLM. Ensure LLMs are configured by running `darwin config set`.
 ```
 
-_See code: [src/commands/search/accession.ts](https://github.com/rpidanny/darwin/blob/v1.28.1/src/commands/search/accession.ts)_
+_See code: [src/commands/search/accession.ts](https://github.com/rpidanny/darwin/blob/v1.28.2/src/commands/search/accession.ts)_
 
 ## `darwin search papers KEYWORDS`
 
 Searches and exports research papers based on keywords to a CSV file.
 
 ```
 USAGE
-  $ darwin search papers KEYWORDS [--log-level TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-c <value>] [-p <value>] [-o
-    <value>] [-f <value>] [-s] [--legacy-processing] [-h] [-S] [--llm-provider openai|ollama]
+  $ darwin search papers KEYWORDS [-l TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-c NUMBER] [-p NUMBER] [-o PATH] [-f
+    REGEX] [-s] [--legacy] [-h] [-S] [--llm openai|ollama]
 
 ARGUMENTS
-  KEYWORDS  The keywords to search for
+  KEYWORDS  The keywords to search for. (Example: "crispr cas9")
 
 FLAGS
-  -S, --include-summary        [LLM Required] Include the paper summary in the output CSV file.
-  -c, --count=<value>          [default: 10] The minimum number of papers to search for.
-  -f, --filter=<value>         Case-insensitive regex to filter papers by content.
-  -h, --headless               Run the browser in headless mode.
-  -o, --output=<value>         [default: .] Specify the output destination for the CSV file.
-  -p, --concurrency=<value>    [default: 10] The number of papers to process in parallel.
-  -s, --skip-captcha           Skip captcha on paper URLs.
-      --legacy-processing      Enable legacy processing of papers that only extracts text from the main URL. The new
-                               method attempts to extract text from the source URLs (pdf or html) and falls back to the
-                               main URL.
-      --llm-provider=<option>  [default: ollama] The LLM provider to use for generating summaries.
-                               <options: openai|ollama>
+  -S, --summary             Include summaries in the output CSV (requires LLM, sets concurrency to 1)
+  -c, --count=NUMBER        [default: 10] Minimum number of papers to search for. Actual number may be slightly higher
+                            with concurrency.
+  -f, --filter=REGEX        Case-insensitive regex to filter papers by content. (Example:
+                            "Colidextribacter|Caproiciproducens")
+  -h, --headless            Run the browser in headless mode (no UI).
+  -o, --output=PATH         [default: .] Destination for the CSV file. Specify folder path for auto-generated filename
+                            or file path for direct use.
+  -p, --concurrency=NUMBER  [default: 10] The number papers to process in parallel.
+  -s, --skip-captcha        Skip captcha on paper URLs. Note: Google Scholar captcha still needs to be solved.
+      --legacy              Enable legacy processing which extracts text only from the main URL. The new method attempts
+                            to extract text from the source URLs (pdf or html) and falls back to the main URL.
+      --llm=openai|ollama   [default: ollama] The LLM provider to use for generating summaries.
 
 GLOBAL FLAGS
-  --log-level=<option>  [default: INFO] Specify level for logging.
-                        <options: TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
+  -l, --log-level=TRACE|DEBUG|INFO|WARN|ERROR|FATAL  [default: INFO] Specify logging level.
 
 EXAMPLES
   $ darwin search papers --help
 
-  $ darwin search papers "crispr cas9" -o crispr_cas9.csv -c 20 --log-level DEBUG
+  $ darwin search papers "crispr cas9" --output crispr_cas9.csv --count 20
 
-  $ darwin search papers "crispr cas9" -o crispr_cas9.csv -c 5 -p 1 -f "tcell" --log-level DEBUG
+  $ darwin search papers "crispr cas9" --output crispr_cas9.csv --filter "tcell" --log-level DEBUG
 
 FLAG DESCRIPTIONS
-  -S, --include-summary  [LLM Required] Include the paper summary in the output CSV file.
+  -S, --summary  Include summaries in the output CSV (requires LLM, sets concurrency to 1)
 
-    Summaries are generated using LLM so make sure LLMs are configured by running `darwin config set`
+    Summaries are generated using LLM. Ensure LLMs are configured by running `darwin config set`.
 ```
 
-_See code: [src/commands/search/papers.ts](https://github.com/rpidanny/darwin/blob/v1.28.1/src/commands/search/papers.ts)_
+_See code: [src/commands/search/papers.ts](https://github.com/rpidanny/darwin/blob/v1.28.2/src/commands/search/papers.ts)_
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@rpidanny/darwin",
   "description": "An elegant CLI wizard enhancing biotech research efficiency, with adaptable features for other domains, albeit with minor constraints.",
-  "version": "1.28.1",
+  "version": "1.28.2",
   "author": "Abhishek <[email protected]>",
   "bin": {
     "darwin": "./bin/run.js"