From 605170459f6f11aefe707e0f023399fdddca6291 Mon Sep 17 00:00:00 2001 From: irfanpena Date: Wed, 3 Jul 2024 14:59:50 +0700 Subject: [PATCH 1/5] Remove the brew installer --- README.md | 13 ------------- cortex-js/README.md | 14 +------------- 2 files changed, 1 insertion(+), 26 deletions(-) diff --git a/README.md b/README.md index fd62c738f..9b7d6ff3a 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,6 @@ Ensure that your system meets the following requirements to run Cortex: > Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started. -### NPM ``` bash # Install using NPM npm i -g cortexso @@ -50,18 +49,6 @@ cortex run llama3 # To uninstall globally using NPM npm uninstall -g cortexso ``` - -### Homebrew -``` bash -# 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: diff --git a/cortex-js/README.md b/cortex-js/README.md index d624fd821..bb425ca93 100644 --- a/cortex-js/README.md +++ b/cortex-js/README.md @@ -38,7 +38,7 @@ Ensure that your system meets the following requirements to run Cortex: > Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started. -### NPM + ``` bash # Install using NPM npm i -g cortexso @@ -50,18 +50,6 @@ cortex run llama3 # To uninstall globally using NPM npm uninstall -g cortexso ``` - -### Homebrew -``` bash -# 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: From 22cd65dc3e3401a4e1a8b5515bc5e6d3babb6e7e Mon Sep 17 00:00:00 2001 From: irfanpena Date: Wed, 3 Jul 2024 15:07:51 +0700 Subject: [PATCH 2/5] Update the commands --- README.md | 23 ++++++++++++++++------- cortex-js/README.md | 23 ++++++++++++++++------- 2 files changed, 32 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9b7d6ff3a..7a95ba04a 100644 --- a/README.md +++ b/README.md @@ -94,14 +94,14 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information. ```bash - serve Providing API endpoint for Cortex backend - chat Send a chat request to a model - init|setup Init settings and download cortex's dependencies - ps Show running models and their status - kill Kill running cortex processes + serve Providing API endpoint for Cortex backend. + chat Send a chat request to a model. + init|setup Init settings and download cortex's dependencies. + ps Show running models and their status. + kill Kill running cortex processes. pull|download Download a model. Working with HuggingFace model id. - run [options] EXPERIMENTAL: Shortcut to start a model and chat - models Subcommands for managing models + run [options] EXPERIMENTAL: Shortcut to start a model and chat. + models Subcommands for managing models. models list List all available models. models pull Download a specified model. models remove Delete a specified model. @@ -112,6 +112,15 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information. 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. + embeddings Creates an embedding vector representing the input text. + engines Subcommands for managing engines. + engines get Get an engine details. + engines list Get all the available Cortex engines. + engines init Setup and download the required dependencies to run cortex engines. + configs Subcommands for managing configurations. + configs get Get a configuration details. + configs list Get all the available configurations. + configs set Set a configuration. ``` ## Contact Support diff --git a/cortex-js/README.md b/cortex-js/README.md index bb425ca93..e0e0508cb 100644 --- a/cortex-js/README.md +++ b/cortex-js/README.md @@ -95,14 +95,14 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information. ```bash - serve Providing API endpoint for Cortex backend - chat Send a chat request to a model - init|setup Init settings and download cortex's dependencies - ps Show running models and their status - kill Kill running cortex processes + serve Providing API endpoint for Cortex backend. + chat Send a chat request to a model. + init|setup Init settings and download cortex's dependencies. + ps Show running models and their status. + kill Kill running cortex processes. pull|download Download a model. Working with HuggingFace model id. - run [options] EXPERIMENTAL: Shortcut to start a model and chat - models Subcommands for managing models + run [options] EXPERIMENTAL: Shortcut to start a model and chat. + models Subcommands for managing models. models list List all available models. models pull Download a specified model. models remove Delete a specified model. @@ -113,6 +113,15 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information. 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. + embeddings Creates an embedding vector representing the input text. + engines Subcommands for managing engines. + engines get Get an engine details. + engines list Get all the available Cortex engines. + engines init Setup and download the required dependencies to run cortex engines. + configs Subcommands for managing configurations. + configs get Get a configuration details. + configs list Get all the available configurations. + configs set Set a configuration. ``` ## Contact Support From bc64f29db4006268a8819006aa435f55f1af5d7b Mon Sep 17 00:00:00 2001 From: irfanpena Date: Thu, 4 Jul 2024 09:37:45 +0700 Subject: [PATCH 3/5] Add brew installation --- README.md | 16 ++++++++++++++-- cortex-js/README.md | 16 ++++++++++++++-- 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7a95ba04a..32cc5fe48 100644 --- a/README.md +++ b/README.md @@ -38,16 +38,28 @@ Ensure that your system meets the following requirements to run Cortex: > Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started. +### NPM +Install using NPM package: ``` bash # Install using NPM npm i -g cortexso +# Run model +cortex run llama3 +# To uninstall globally using NPM +npm uninstall -g cortexso +``` + +### Homebrew +Install using Homebrew: +``` bash # Install using Brew brew tap janhq/cortexso brew install cortexso # Run model cortex run llama3 -# To uninstall globally using NPM -npm uninstall -g cortexso +# 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). diff --git a/cortex-js/README.md b/cortex-js/README.md index e0e0508cb..020909c48 100644 --- a/cortex-js/README.md +++ b/cortex-js/README.md @@ -39,16 +39,28 @@ Ensure that your system meets the following requirements to run Cortex: > Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started. +### NPM +Install using NPM package: ``` bash # Install using NPM npm i -g cortexso +# Run model +cortex run llama3 +# To uninstall globally using NPM +npm uninstall -g cortexso +``` + +### Homebrew +Install using Homebrew: +``` bash # Install using Brew brew tap janhq/cortexso brew install cortexso # Run model cortex run llama3 -# To uninstall globally using NPM -npm uninstall -g cortexso +# 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). From 781b1e4af1eaf860adb596aaf833e77a8faeee54 Mon Sep 17 00:00:00 2001 From: irfanpena Date: Thu, 4 Jul 2024 09:45:44 +0700 Subject: [PATCH 4/5] Add the brew installer --- README.md | 2 -- cortex-js/README.md | 2 -- 2 files changed, 4 deletions(-) diff --git a/README.md b/README.md index 32cc5fe48..57e6a0150 100644 --- a/README.md +++ b/README.md @@ -53,13 +53,11 @@ npm uninstall -g cortexso Install using Homebrew: ``` bash # 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). diff --git a/cortex-js/README.md b/cortex-js/README.md index 020909c48..b9d0514bf 100644 --- a/cortex-js/README.md +++ b/cortex-js/README.md @@ -54,13 +54,11 @@ npm uninstall -g cortexso Install using Homebrew: ``` bash # 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). From dcfcb75d812a9b3c9281ec824e4f027a6a78ff71 Mon Sep 17 00:00:00 2001 From: irfanpena Date: Thu, 4 Jul 2024 19:25:55 +0700 Subject: [PATCH 5/5] fix: readme added the tap brew code --- README.md | 2 ++ cortex-js/README.md | 10 ++++++---- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2c0d81964..64f0d1b95 100644 --- a/README.md +++ b/README.md @@ -53,10 +53,12 @@ npm uninstall -g cortexso Install using Homebrew: ``` bash # Install using Brew +brew tap janhq/cortexso brew install cortexso # Run model cortex run llama3 # To uninstall using Brew +brew untap janhq/cortexso brew uninstall cortexso ``` > You can also install Cortex using the Cortex Installer available on [GitHub Releases](https://github.com/janhq/cortex/releases). diff --git a/cortex-js/README.md b/cortex-js/README.md index b9d0514bf..a5cbbcb88 100644 --- a/cortex-js/README.md +++ b/cortex-js/README.md @@ -21,8 +21,8 @@ Cortex currently supports 3 inference engines: ## Quicklinks -- [Homepage](https://cortex.jan.ai/) -- [Docs](https://cortex.jan.ai/docs/) +- [Homepage](https://cortex.so/) +- [Docs](https://cortex.so/docs/) ## Quickstart ### Prerequisites @@ -36,7 +36,7 @@ Ensure that your system meets the following requirements to run Cortex: - Windows 10 or higher. - Ubuntu 22.04 and later. -> Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started. +> Visit [Quickstart](https://cortex.so/docs/quickstart) to get started. ### NPM @@ -54,10 +54,12 @@ npm uninstall -g cortexso Install using Homebrew: ``` bash # Install using Brew +brew tap janhq/cortexso brew install cortexso # Run model cortex run llama3 # To uninstall using Brew +brew untap janhq/cortexso brew uninstall cortexso ``` > You can also install Cortex using the Cortex Installer available on [GitHub Releases](https://github.com/janhq/cortex/releases). @@ -101,7 +103,7 @@ npm link ## Cortex CLI Commands The following CLI commands are currently available. -See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information. +See [CLI Reference Docs](https://cortex.so/docs/cli) for more information. ```bash