Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

Commit b01da3b

Browse files
authored
Remove the brew installer (#817)
1 parent 4d05273 commit b01da3b

File tree

2 files changed

+33
-40
lines changed

2 files changed

+33
-40
lines changed

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ Ensure that your system meets the following requirements to run Cortex:
3838

3939
> Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started.
4040
41-
### NPM
4241
``` bash
4342
# Install using NPM
4443
npm i -g cortexso
@@ -50,18 +49,6 @@ cortex run llama3
5049
# To uninstall globally using NPM
5150
npm uninstall -g cortexso
5251
```
53-
54-
### Homebrew
55-
``` bash
56-
# Install using Brew
57-
brew tap janhq/cortexso
58-
brew install cortexso
59-
# Run model
60-
cortex run llama3
61-
# To uninstall using Brew
62-
brew uninstall cortexso
63-
brew untap janhq/cortexso
64-
```
6552
> You can also install Cortex using the Cortex Installer available on [GitHub Releases](https://github.com/janhq/cortex/releases).
6653
6754
To run Cortex as an API server:
@@ -107,14 +94,14 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information.
10794

10895
```bash
10996

110-
serve Providing API endpoint for Cortex backend
111-
chat Send a chat request to a model
112-
init|setup Init settings and download cortex's dependencies
113-
ps Show running models and their status
114-
kill Kill running cortex processes
97+
serve Providing API endpoint for Cortex backend.
98+
chat Send a chat request to a model.
99+
init|setup Init settings and download cortex's dependencies.
100+
ps Show running models and their status.
101+
kill Kill running cortex processes.
115102
pull|download Download a model. Working with HuggingFace model id.
116-
run [options] EXPERIMENTAL: Shortcut to start a model and chat
117-
models Subcommands for managing models
103+
run [options] EXPERIMENTAL: Shortcut to start a model and chat.
104+
models Subcommands for managing models.
118105
models list List all available models.
119106
models pull Download a specified model.
120107
models remove Delete a specified model.
@@ -125,6 +112,15 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information.
125112
benchmark Benchmark and analyze the performance of a specific AI model using your system.
126113
presets Show all the available model presets within Cortex.
127114
telemetry Retrieve telemetry logs for monitoring and analysis.
115+
embeddings Creates an embedding vector representing the input text.
116+
engines Subcommands for managing engines.
117+
engines get Get an engine details.
118+
engines list Get all the available Cortex engines.
119+
engines init Setup and download the required dependencies to run cortex engines.
120+
configs Subcommands for managing configurations.
121+
configs get Get a configuration details.
122+
configs list Get all the available configurations.
123+
configs set Set a configuration.
128124
```
129125
130126
## Contact Support

cortex-js/README.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Ensure that your system meets the following requirements to run Cortex:
3838

3939
> Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started.
4040
41-
### NPM
41+
4242
``` bash
4343
# Install using NPM
4444
npm i -g cortexso
@@ -50,18 +50,6 @@ cortex run llama3
5050
# To uninstall globally using NPM
5151
npm uninstall -g cortexso
5252
```
53-
54-
### Homebrew
55-
``` bash
56-
# Install using Brew
57-
brew tap janhq/cortexso
58-
brew install cortexso
59-
# Run model
60-
cortex run llama3
61-
# To uninstall using Brew
62-
brew uninstall cortexso
63-
brew untap janhq/cortexso
64-
```
6553
> You can also install Cortex using the Cortex Installer available on [GitHub Releases](https://github.com/janhq/cortex/releases).
6654
6755
To run Cortex as an API server:
@@ -107,14 +95,14 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information.
10795

10896
```bash
10997

110-
serve Providing API endpoint for Cortex backend
111-
chat Send a chat request to a model
112-
init|setup Init settings and download cortex's dependencies
113-
ps Show running models and their status
114-
kill Kill running cortex processes
98+
serve Providing API endpoint for Cortex backend.
99+
chat Send a chat request to a model.
100+
init|setup Init settings and download cortex's dependencies.
101+
ps Show running models and their status.
102+
kill Kill running cortex processes.
115103
pull|download Download a model. Working with HuggingFace model id.
116-
run [options] EXPERIMENTAL: Shortcut to start a model and chat
117-
models Subcommands for managing models
104+
run [options] EXPERIMENTAL: Shortcut to start a model and chat.
105+
models Subcommands for managing models.
118106
models list List all available models.
119107
models pull Download a specified model.
120108
models remove Delete a specified model.
@@ -125,6 +113,15 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information.
125113
benchmark Benchmark and analyze the performance of a specific AI model using your system.
126114
presets Show all the available model presets within Cortex.
127115
telemetry Retrieve telemetry logs for monitoring and analysis.
116+
embeddings Creates an embedding vector representing the input text.
117+
engines Subcommands for managing engines.
118+
engines get Get an engine details.
119+
engines list Get all the available Cortex engines.
120+
engines init Setup and download the required dependencies to run cortex engines.
121+
configs Subcommands for managing configurations.
122+
configs get Get a configuration details.
123+
configs list Get all the available configurations.
124+
configs set Set a configuration.
128125
```
129126
130127
## Contact Support

0 commit comments

Comments
 (0)