Skip to content

Commit

Permalink
Remove the brew installer (#817)
Browse files Browse the repository at this point in the history
  • Loading branch information
@irfanpena
irfanpena committed Jul 3, 2024
1 parent 4d05273 commit b01da3b
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 40 deletions.
36 changes: 16 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -107,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.
Expand All @@ -125,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
Expand Down
37 changes: 17 additions & 20 deletions cortex-js/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -107,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.
Expand All @@ -125,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
Expand Down

0 comments on commit b01da3b

Please sign in to comment.