Update Readme and the URL for the API documentation

README.md

@@ -25,13 +25,45 @@ Cortex currently supports 3 inference engines:
 - [Docs](https://cortex.jan.ai/docs/)
 
 ## Quickstart
+### Prerequisites
+Ensure that your system meets the following requirements to run Cortex:
+- **Dependencies**:
+  - **Node.js**: version 18 and above is required to run the installation.
+  - **NPM**: Needed to manage packages.
+  - **CPU Instruction Sets**: Available for download from the [Cortex GitHub Releases](https://github.com/janhq/cortex/releases) page.
+- **OS**:
+  - MacOSX 13.6 or higher.
+  - Windows 10 or higher.
+  - Ubuntu 22.04 and later.
+
+> Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started.
+
+### NPM
+``` bash
+# Install using NPM
+npm i -g cortexso
+# Install using Brew
+brew tap janhq/cortexso
+brew install cortexso
+# Run model
+cortex run llama3
+# To uninstall globally using NPM
+npm uninstall -g cortexso
+```
 
-Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started.
-
+### Homebrew
 ``` bash
-npm i -g @janhq/cortex
+# Install using Brew
+brew tap janhq/cortexso
+brew install cortexso
+# Run model
 cortex run llama3
+# To uninstall using Brew
+brew uninstall cortexso
+brew untap janhq/cortexso
 ```
+> You can also install Cortex using the Cortex Installer available on [GitHub Releases](https://github.com/janhq/cortex/releases).
+
 To run Cortex as an API server:
 ```bash
 cortex serve
@@ -90,18 +122,13 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information.
   models start        Start a specified model.
   models stop         Stop a specified model.
   models update       Update the configuration of a specified model.
-```
-
-## Uninstall Cortex
-
-Run the following command to uninstall Cortex globally on your machine:
-
-```
-# Uninstall globally using NPM
-npm uninstall -g @janhq/cortex
+  benchmark           Benchmark and analyze the performance of a specific AI model using your system.
+  presets             Show all the available model presets within Cortex.
+  telemetry           Retrieve telemetry logs for monitoring and analysis.
 ```
 
 ## Contact Support
 - For support, please file a GitHub ticket.
 - For questions, join our Discord [here](https://discord.gg/FTk2MvZwJH).
 - For long-form inquiries, please email [hello@jan.ai](mailto:hello@jan.ai).
+

cortex-js/README.md

@@ -1,4 +1,4 @@
-# Cortex - CLI
+# Cortex
 <p align="center">
   <img alt="cortex-cpplogo" src="https://raw.githubusercontent.com/janhq/cortex/dev/assets/cortex-banner.png">
 </p>
@@ -11,91 +11,71 @@
 > ⚠️ **Cortex is currently in Development**: Expect breaking changes and bugs!
 
 ## About
-Cortex is an openAI-compatible local AI server that developers can use to build LLM apps. It is packaged with a Docker-inspired command-line interface and a Typescript client library. It can be used as a standalone server, or imported as a library. 
+Cortex is an OpenAI-compatible AI engine that developers can use to build LLM apps. It is packaged with a Docker-inspired command-line interface and client libraries. It can be used as a standalone server or imported as a library. 
 
-Cortex currently supports two inference engines:
+Cortex currently supports 3 inference engines:
 
 - Llama.cpp
+- ONNX Runtime
 - TensorRT-LLM
 
-> Read more about Cortex at https://jan.ai/cortex
-
 ## Quicklinks
-Cortex
-- [Website](https://jan.ai/)
-- [GitHub](https://github.com/janhq/cortex)
-- [User Guides](https://jan.ai/cortex)
-- [API reference](https://jan.ai/api-reference)
-
-## Prerequisites
-
-### **Dependencies**
-
-Before installation, ensure that you have installed the following:
-- **Node.js**: version 18 and above is required to run the installation.
-- **NPM**: Needed to manage packages.
-- **CPU Instruction Sets**: Available for download from the [Cortex GitHub Releases](https://github.com/janhq/cortex/releases) page.
-
-
->💡 The **CPU instruction sets** are not required for the initial installation of Cortex. This dependency will be automatically installed during the Cortex initialization if they are not already on your system.
-
 
-### **Hardware**
+- [Homepage](https://cortex.jan.ai/)
+- [Docs](https://cortex.jan.ai/docs/)
 
+## Quickstart
+### Prerequisites
 Ensure that your system meets the following requirements to run Cortex:
-
+- **Dependencies**:
+  - **Node.js**: version 18 and above is required to run the installation.
+  - **NPM**: Needed to manage packages.
+  - **CPU Instruction Sets**: Available for download from the [Cortex GitHub Releases](https://github.com/janhq/cortex/releases) page.
 - **OS**:
   - MacOSX 13.6 or higher.
   - Windows 10 or higher.
   - Ubuntu 22.04 and later.
-- **RAM (CPU Mode):**
-  - 8GB for running up to 3B models.
-  - 16GB for running up to 7B models.
-  - 32GB for running up to 13B models.
-- **VRAM (GPU Mode):**
 
-  - 6GB can load the 3B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
-  - 8GB can load the 7B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
-  - 12GB can load the 13B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
+> Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started.
 
-- **Disk**: At least 10GB for app and model download.
-
-## Quickstart
-To install Cortex CLI, follow the steps below:
-1. Install the Cortex NPM package globally:
+### NPM
 ``` bash
+# Install using NPM
 npm i -g cortexso
-```
-> Cortex automatically detects your CPU and GPU, downloading the appropriate CPU instruction sets and required dependencies to optimize GPU performance.
-
-2. Download a GGUF model from Hugging Face:
-``` bash
-# Pull a model most compatible with your hardware
-cortex pull llama3
-
-# Pull a specific variant with `repo_name:branch`
-cortex pull llama3:7b
-
-# Pull a model with the HuggingFace `model_id`
-cortex pull microsoft/Phi-3-mini-4k-instruct-gguf
-```
-3. Load the model:
-``` bash
-cortex models start llama3:7b
+# Install using Brew
+brew tap janhq/cortexso
+brew install cortexso
+# Run model
+cortex run llama3
+# To uninstall globally using NPM
+npm uninstall -g cortexso
 ```
 
-4. Start chatting with the model:
+### Homebrew
 ``` bash
-cortex chat tell me a joke
+# Install using Brew
+brew tap janhq/cortexso
+brew install cortexso
+# Run model
+cortex run llama3
+# To uninstall using Brew
+brew uninstall cortexso
+brew untap janhq/cortexso
 ```
+> You can also install Cortex using the Cortex Installer available on [GitHub Releases](https://github.com/janhq/cortex/releases).
 
-
-## Run as an API server
 To run Cortex as an API server:
 ```bash
 cortex serve
+
+# Output
+# Started server at http://localhost:1337
+# Swagger UI available at http://localhost:1337/api
 ```
 
+You can now access the Cortex API server at `http://localhost:1337`,
+and the Swagger UI at `http://localhost:1337/api`.
+
 ## Build from Source
 
 To install Cortex from the source, follow the steps below:
@@ -120,9 +100,10 @@ chmod +x '[path-to]/cortex/cortex-js/dist/src/command.js'
 npm link
 ```
 
-## Cortex CLI Command
-The following CLI commands are currently available:
-> ⚠️ **Cortex is currently in Development**: More commands will be added soon!
+## Cortex CLI Commands
+
+The following CLI commands are currently available.
+See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information.
 
 ```bash
 
@@ -141,18 +122,12 @@ The following CLI commands are currently available:
   models start        Start a specified model.
   models stop         Stop a specified model.
   models update       Update the configuration of a specified model.
-  engines             Execute a specified command related to engines.
-  engines list        List all available engines.
+  benchmark           Benchmark and analyze the performance of a specific AI model using your system.
+  presets             Show all the available model presets within Cortex.
+  telemetry           Retrieve telemetry logs for monitoring and analysis.
 ```
-## Uninstall Cortex
-
-Run the following command to uninstall Cortex globally on your machine:
 
-```
-# Uninstall globally using NPM
-npm uninstall -g cortexso
-```
 ## Contact Support
 - For support, please file a GitHub ticket.
 - For questions, join our Discord [here](https://discord.gg/FTk2MvZwJH).
-- For long-form inquiries, please email [hello@jan.ai](mailto:hello@jan.ai).
+- For long-form inquiries, please email [hello@jan.ai](mailto:hello@jan.ai).

cortex-js/src/app.ts

@@ -23,7 +23,7 @@ export const getApp = async () => {
   const config = new DocumentBuilder()
     .setTitle('Cortex API')
     .setDescription(
-      'Cortex API provides a command-line interface (CLI) for seamless interaction with large language models (LLMs). Fully compatible with the [OpenAI API](https://platform.openai.com/docs/api-reference), it enables straightforward command execution and management of LLM interactions.',
+      'Cortex API provides a command-line interface (CLI) for seamless interaction with large language models (LLMs). It is fully compatible with the [OpenAI API](https://platform.openai.com/docs/api-reference) and enables straightforward command execution and management of LLM interactions.',
     )
     .setVersion('1.0')
     .addTag(

cortex-js/src/infrastructure/controllers/status.controller.ts

@@ -8,7 +8,7 @@ export class StatusController {
 
   @ApiOperation({
     summary: "Get health status",
-    description: "Retrieves the health status of the Cortex's API endpoint server.",
+    description: "Retrieves the health status of your Cortex's system.",
   })
   @HttpCode(200)
   @ApiResponse({