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

Commit 57f8a0b

Browse files
authored
fix: Update release link (#1448)
1 parent 9501975 commit 57f8a0b

File tree

1 file changed

+54
-20
lines changed

1 file changed

+54
-20
lines changed

README.md

Lines changed: 54 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Cortex.cpp
2+
23
<p align="center">
34
<img width="1280" alt="Cortex cpp's Readme Banner" src="https://github.com/user-attachments/assets/a27c0435-b3b4-406f-b575-96ac4f12244c">
45

@@ -21,45 +22,56 @@
2122
> ⚠️ **Cortex.cpp is currently in active development. This outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.**
2223
2324
## Overview
25+
2426
Cortex.cpp is a Local AI engine that is used to run and customize LLMs. Cortex can be deployed as a standalone server, or integrated into apps like [Jan.ai](https://jan.ai/).
2527

2628
Cortex.cpp is a multi-engine that uses `llama.cpp` as the default engine but also supports the following:
29+
2730
- [`llamacpp`](https://github.com/janhq/cortex.llamacpp)
2831
- [`onnx`](https://github.com/janhq/cortex.onnx)
2932
- [`tensorrt-llm`](https://github.com/janhq/cortex.tensorrt-llm)
3033

3134
## Installation
35+
3236
This Local Installer packages all required dependencies, so that you don’t need an internet connection during the installation process.
3337

3438
Alternatively, Cortex is available with a [Network Installer](#network-installer) which downloads the necessary dependencies from the internet during the installation.
39+
3540
### Stable
36-
### Windows:
41+
42+
### Windows:
43+
3744
<a href='https://app.cortexcpp.com/download/latest/windows-amd64-local'>
3845
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
3946
<b>cortex-local-installer.exe</b>
4047
</a>
4148

42-
### MacOS:
49+
### MacOS:
50+
4351
<a href='https://app.cortexcpp.com/download/latest/mac-universal-local'>
4452
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
4553
<b>cortex-local-installer.pkg</b>
4654
</a>
4755

48-
### Linux:
56+
### Linux:
57+
4958
<a href='https://app.cortexcpp.com/download/latest/linux-amd64-local'>
5059
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
5160
<b>cortex-local-installer.deb</b>
5261
</a>
5362

5463
Download the installer and run the following command in terminal:
64+
5565
```bash
5666
sudo apt install ./cortex-local-installer.deb
5767
# or
5868
sudo apt install ./cortex-network-installer.deb
5969
```
70+
6071
The binary will be installed in the `/usr/bin/` directory.
6172

6273
## Usage
74+
6375
After installation, you can run Cortex.cpp from the command line by typing `cortex --help`. For Beta preview, you can run `cortex-beta --help`.
6476

6577
## Built-in Model Library
@@ -68,33 +80,36 @@ Cortex.cpp supports various models available on the [Cortex Hub](https://hugging
6880

6981
Example models:
7082

71-
| Model | llama.cpp<br >`:gguf` | TensorRT<br >`:tensorrt` | ONNXRuntime<br >`:onnx` | Command |
72-
|------------------|-----------------------|------------------------------------------|----------------------------|-------------------------------|
73-
| llama3.1 | | | | cortex run llama3.1:gguf |
74-
| llama3 | | | | cortex run llama3 |
75-
| mistral | | | | cortex run mistral |
76-
| qwen2 | | | | cortex run qwen2:7b-gguf |
77-
| codestral | | | | cortex run codestral:22b-gguf |
78-
| command-r | | | | cortex run command-r:35b-gguf |
79-
| gemma | | | | cortex run gemma |
80-
| mixtral | | | | cortex run mixtral:7x8b-gguf |
81-
| openhermes-2.5 | | | | cortex run openhermes-2.5 |
82-
| phi3 (medium) | | | | cortex run phi3:medium |
83-
| phi3 (mini) | | | | cortex run phi3:mini |
84-
| tinyllama | | | | cortex run tinyllama:1b-gguf |
83+
| Model | llama.cpp<br >`:gguf` | TensorRT<br >`:tensorrt` | ONNXRuntime<br >`:onnx` | Command |
84+
| -------------- | --------------------- | ------------------------ | ----------------------- | ----------------------------- |
85+
| llama3.1 || || cortex run llama3.1:gguf |
86+
| llama3 |||| cortex run llama3 |
87+
| mistral |||| cortex run mistral |
88+
| qwen2 || | | cortex run qwen2:7b-gguf |
89+
| codestral || | | cortex run codestral:22b-gguf |
90+
| command-r || | | cortex run command-r:35b-gguf |
91+
| gemma || || cortex run gemma |
92+
| mixtral || | | cortex run mixtral:7x8b-gguf |
93+
| openhermes-2.5 |||| cortex run openhermes-2.5 |
94+
| phi3 (medium) || || cortex run phi3:medium |
95+
| phi3 (mini) || || cortex run phi3:mini |
96+
| tinyllama || | | cortex run tinyllama:1b-gguf |
8597

8698
> **Note**:
8799
> You should have at least 8 GB of RAM available to run the 7B models, 16 GB to run the 14B models, and 32 GB to run the 32B models.
88100
89101
## Cortex.cpp CLI Commands
102+
90103
For complete details on CLI commands, please refer to our [CLI documentation](https://cortex.so/docs/cli).
91104

92105
## REST API
106+
93107
Cortex.cpp includes a REST API accessible at `localhost:39281`. For a complete list of endpoints and their usage, visit our [API documentation](https://cortex.so/api-reference).
94108

95109
## Advanced Installation
96110

97-
### Local Installer: Beta & Nightly Versions
111+
### Local Installer: Beta & Nightly Versions
112+
98113
Beta is an early preview for new versions of Cortex. It is for users who want to try new features early - we appreciate your feedback.
99114

100115
Nightly is our development version of Brave. It is released every night and may contain bugs and experimental features.
@@ -172,6 +187,7 @@ Nightly is our development version of Brave. It is released every night and may
172187
</table>
173188

174189
### Network Installer
190+
175191
Cortex.cpp is available with a Network Installer, which is a smaller installer but requires internet connection during installation to download the necessary dependencies.
176192

177193
<table>
@@ -189,13 +205,13 @@ Cortex.cpp is available with a Network Installer, which is a smaller installer b
189205
<b>cortex-network-installer.exe</b>
190206
</a>
191207
<td style="text-align:center">
192-
<a href='https://app.cortexcpp.com/download/beta/mac-universal-network'>
208+
<a href='https://app.cortexcpp.com/download/latest/mac-universal-network'>
193209
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
194210
<b>cortex-network-installer.pkg</b>
195211
</a>
196212
</td>
197213
<td style="text-align:center">
198-
<a href='https://app.cortexcpp.com/download/beta/linux-amd64-network'>
214+
<a href='https://app.cortexcpp.com/download/latest/linux-amd64-network'>
199215
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
200216
<b>cortex-network-installer.deb</b>
201217
</a>
@@ -248,6 +264,7 @@ Cortex.cpp is available with a Network Installer, which is a smaller installer b
248264
### Build from Source
249265

250266
#### Windows
267+
251268
1. Clone the Cortex.cpp repository [here](https://github.com/janhq/cortex.cpp).
252269
2. Navigate to the `engine > vcpkg` folder.
253270
3. Configure the vpkg:
@@ -257,21 +274,25 @@ cd vcpkg
257274
./bootstrap-vcpkg.bat
258275
vcpkg install
259276
```
277+
260278
4. Build the Cortex.cpp inside the `build` folder:
261279

262280
```bash
263281
mkdir build
264282
cd build
265283
cmake .. -DBUILD_SHARED_LIBS=OFF -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static
266284
```
285+
267286
5. Use Visual Studio with the C++ development kit to build the project using the files generated in the `build` folder.
268287
6. Verify that Cortex.cpp is installed correctly by getting help information.
269288

270289
```sh
271290
# Get the help information
272291
cortex -h
273292
```
293+
274294
#### MacOS
295+
275296
1. Clone the Cortex.cpp repository [here](https://github.com/janhq/cortex.cpp).
276297
2. Navigate to the `engine > vcpkg` folder.
277298
3. Configure the vpkg:
@@ -281,6 +302,7 @@ cd vcpkg
281302
./bootstrap-vcpkg.sh
282303
vcpkg install
283304
```
305+
284306
4. Build the Cortex.cpp inside the `build` folder:
285307

286308
```bash
@@ -289,14 +311,17 @@ cd build
289311
cmake .. -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder/vcpkg/scripts/buildsystems/vcpkg.cmake
290312
make -j4
291313
```
314+
292315
5. Use Visual Studio with the C++ development kit to build the project using the files generated in the `build` folder.
293316
6. Verify that Cortex.cpp is installed correctly by getting help information.
294317

295318
```sh
296319
# Get the help information
297320
cortex -h
298321
```
322+
299323
#### Linux
324+
300325
1. Clone the Cortex.cpp repository [here](https://github.com/janhq/cortex.cpp).
301326
2. Navigate to the `engine > vcpkg` folder.
302327
3. Configure the vpkg:
@@ -306,6 +331,7 @@ cd vcpkg
306331
./bootstrap-vcpkg.sh
307332
vcpkg install
308333
```
334+
309335
4. Build the Cortex.cpp inside the `build` folder:
310336

311337
```bash
@@ -314,6 +340,7 @@ cd build
314340
cmake .. -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder/vcpkg/scripts/buildsystems/vcpkg.cmake
315341
make -j4
316342
```
343+
317344
5. Use Visual Studio with the C++ development kit to build the project using the files generated in the `build` folder.
318345
6. Verify that Cortex.cpp is installed correctly by getting help information.
319346

@@ -323,25 +350,32 @@ cortex
323350
```
324351

325352
## Uninstallation
353+
326354
### Windows
355+
327356
1. Open the Windows Control Panel.
328357
2. Navigate to `Add or Remove Programs`.
329358
3. Search for `cortexcpp` and double click to uninstall. (for beta and nightly builds, search for `cortexcpp-beta` and `cortexcpp-nightly` respectively)
330359

331360
### MacOs
361+
332362
Run the uninstaller script:
363+
333364
```bash
334365
sudo sh cortex-uninstall.sh
335366
```
367+
336368
For MacOS, there is a uninstaller script comes with the binary and added to the `/usr/local/bin/` directory. The script is named `cortex-uninstall.sh` for stable builds, `cortex-beta-uninstall.sh` for beta builds and `cortex-nightly-uninstall.sh` for nightly builds.
337369

338370
### Linux
371+
339372
```bash
340373
# For stable builds
341374
sudo apt remove cortexcpp
342375
```
343376

344377
## Contact Support
378+
345379
- For support, please file a [GitHub ticket](https://github.com/janhq/cortex.cpp/issues/new/choose).
346380
- For questions, join our Discord [here](https://discord.gg/FTk2MvZwJH).
347381
- For long-form inquiries, please email [hello@jan.ai](mailto:hello@jan.ai).

0 commit comments

Comments
 (0)