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

Commit b5051ed

Browse files
author
Gabrielle Ong
authored
Update README.md
1 parent ee41d48 commit b5051ed

File tree

1 file changed

+91
-115
lines changed

1 file changed

+91
-115
lines changed

‎README.md‎

Lines changed: 91 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -31,69 +31,64 @@ Cortex.cpp is a multi-engine that uses `llama.cpp` as the default engine but als
3131
- [`onnx`](https://github.com/janhq/cortex.onnx)
3232
- [`tensorrt-llm`](https://github.com/janhq/cortex.tensorrt-llm)
3333

34-
## Installation
34+
## Local Installation
3535

36-
This Local Installer packages all required dependencies, so that you don’t need an internet connection during the installation process.
36+
Cortex has an Local Installer that packages all required dependencies, so that no internet connection is required during the installation process.
3737

38-
Alternatively, Cortex is available with a [Network Installer](#network-installer) which downloads the necessary dependencies from the internet during the installation.
38+
Cortex also has a [Network Installer](#network-installer) which downloads the necessary dependencies from the internet during the installation.
3939

40-
### Stable
40+
<h4>
41+
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:15px; width: 15px" />
42+
Windows:
43+
<a href='https://app.cortexcpp.com/download/latest/windows-amd64-local'><b>cortex-windows-local-installer.exe</b></a>
44+
</h4>
4145

42-
### Windows:
43-
44-
<a href='https://app.cortexcpp.com/download/latest/windows-amd64-local'>
45-
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
46-
<b>cortex-local-installer.exe</b>
47-
</a>
48-
49-
### MacOS:
50-
51-
<a href='https://app.cortexcpp.com/download/latest/mac-universal-local'>
46+
<h4>
5247
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
53-
<b>cortex-local-installer.pkg</b>
54-
</a>
55-
56-
### Linux:
48+
MacOS (Silicon/Intel):
49+
<a href='https://app.cortexcpp.com/download/latest/mac-universal-local'><b>cortex-mac-local-installer.pkg</b></a>
50+
</h4>
5751

58-
<a href='https://app.cortexcpp.com/download/latest/linux-amd64-local'>
59-
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
60-
<b>cortex-local-installer.deb</b>
61-
</a>
52+
<h4>
53+
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:15px; width: 15px" />
54+
Linux:
55+
<a href='https://app.cortexcpp.com/download/latest/linux-amd64-local'><b>cortex-linux-local-installer.deb</b></a>
56+
</h4>
6257

63-
Download the installer and run the following command in terminal:
58+
- For Linux: Download the installer and run the following command in terminal:
6459

6560
```bash
6661
sudo apt install ./cortex-local-installer.deb
6762
# or
6863
sudo apt install ./cortex-network-installer.deb
6964
```
7065

71-
The binary will be installed in the `/usr/bin/` directory.
66+
- The binary will be installed in the `/usr/bin/` directory.
7267

7368
## Usage
7469

7570
After installation, you can run Cortex.cpp from the command line by typing `cortex --help`. For Beta preview, you can run `cortex-beta --help`.
7671

7772
## Built-in Model Library
7873

79-
Cortex.cpp supports various models available on the [Cortex Hub](https://huggingface.co/cortexso). Once downloaded, all model source files will be stored in `~\cortexcpp\models`.
74+
Cortex.cpp supports various models available on the [Cortex Hub](https://huggingface.co/cortexso).
75+
Once downloaded, the model `.gguf` and `model.yml` files are stored in `~\cortexcpp\models`.
8076

8177
Example models:
8278

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 |
79+
| Model /Engine | llama.cpp | Command |
80+
| -------------- | --------------------- | ----------------------------- |
81+
| llama3.1 | ✅ | cortex run llama3.1 |
82+
| llama3 | ✅ | cortex run llama3 |
83+
| mistral | ✅ | cortex run mistral |
84+
| qwen2 | ✅ | cortex run qwen2 |
85+
| codestral | ✅ | cortex run codestral |
86+
| command-r | ✅ | cortex run command-r |
87+
| gemma | ✅ | cortex run gemma |
88+
| mixtral | ✅ | cortex run mixtral |
89+
| openhermes-2.5 | ✅ | cortex run openhermes-2.5 |
90+
| phi3 | ✅ | cortex run phi3 |
91+
| tinyllama | ✅ | cortex run tinyllama |
9792

9893
> **Note**:
9994
> 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.
@@ -108,154 +103,135 @@ Cortex.cpp includes a REST API accessible at `localhost:39281`. For a complete l
108103

109104
## Advanced Installation
110105

111-
### Local Installer: Beta & Nightly Versions
106+
### Network Installer
112107

113-
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.
108+
Cortex.cpp is available with a Network Installer, which is a smaller installer but requires internet connection during installation to download the necessary dependencies.
109+
110+
<h4>
111+
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
112+
Windows:
113+
<a href='https://app.cortexcpp.com/download/latest/windows-amd64-local'><b>cortex-windows-network-installer.exe</b></a>
114+
</h4>
115+
116+
<h4>
117+
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
118+
MacOS (Universal):
119+
<a href='https://app.cortexcpp.com/download/latest/mac-universal-network'><b>cortex-mac-network-installer.pkg</b></a>
120+
</h4>
121+
122+
<h4>
123+
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 15px" />
124+
Linux:
125+
<a href='https://app.cortexcpp.com/download/latest/linux-amd64-network'><b>cortex-linux-network-installer.deb</b></a>
126+
</h4>
127+
128+
129+
### Beta & Nightly Versions
130+
131+
Beta is an early preview for new versions of Cortex. It is for users who want to try new features early and provide us feedback.
114132

115133
Nightly is our development version of Cortex. It is released every night and may contain bugs and experimental features.
116134

135+
#### Network Installer
136+
117137
<table>
118138
<tr style="text-align:center">
119139
<td style="text-align:center"><b>Version Type</b></td>
120140
<td style="text-align:center"><b>Windows</b></td>
121141
<td style="text-align:center"><b>MacOS</b></td>
122142
<td style="text-align:center"><b>Linux</b></td>
123143
</tr>
124-
<tr style="text-align:center">
125-
<td style="text-align:center"><b>Stable (Recommended)</b></td>
126-
<td style="text-align:center">
127-
<a href='https://app.cortexcpp.com/download/latest/windows-amd64-local'>
128-
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
129-
<b>cortex-local-installer.exe</b>
130-
</a>
131-
</td>
132-
<td style="text-align:center">
133-
<a href='https://app.cortexcpp.com/download/latest/mac-universal-local'>
134-
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
135-
<b>cortex-local-installer.pkg</b>
136-
</a>
137-
</td>
138-
<td style="text-align:center">
139-
<a href='https://app.cortexcpp.com/download/latest/linux-amd64-local'>
140-
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
141-
<b>cortex-local-installer.deb</b>
142-
</a>
143-
</td>
144-
</tr>
145144
<tr style="text-align:center">
146145
<td style="text-align:center"><b>Beta (Preview)</b></td>
147146
<td style="text-align:center">
148-
<a href='https://app.cortexcpp.com/download/beta/windows-amd64-local'>
147+
<a href='https://app.cortexcpp.com/download/beta/windows-amd64-network'>
149148
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
150-
<b>cortex-local-installer.exe</b>
149+
<b>cortex-beta-windows-network-installer.exe</b>
151150
</a>
152151
</td>
153152
<td style="text-align:center">
154-
<a href='https://app.cortexcpp.com/download/beta/mac-universal-local'>
153+
<a href='https://app.cortexcpp.com/download/beta/mac-universal-network'>
155154
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
156-
<b>cortex-local-installer.pkg</b>
155+
<b>cortex-beta-mac-network-installer.pkg</b>
157156
</a>
158157
</td>
159158
<td style="text-align:center">
160-
<a href='https://app.cortexcpp.com/download/beta/linux-amd64-local'>
161-
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
162-
<b>cortex-local-installer.deb</b>
159+
<a href='https://app.cortexcpp.com/download/beta/linux-amd64-network'>
160+
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:15px; width: 15px" />
161+
<b>cortex-beta-linux-network-installer.deb</b>
163162
</a>
164163
</td>
165164
</tr>
166165
<tr style="text-align:center">
167-
<td style="text-align:center"><b>Nightly Build (Experimental)</b></td>
166+
<td style="text-align:center"><b>Nightly (Experimental)</b></td>
168167
<td style="text-align:center">
169-
<a href='https://app.cortexcpp.com/download/nightly/windows-amd64-local'>
170-
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
171-
<b>cortex-local-installer.exe</b>
168+
<a href='https://app.cortexcpp.com/download/nightly/windows-amd64-network'>
169+
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:15px; width: 15px" />
170+
<b>cortex-nightly-windows-network-installer.exe</b>
172171
</a>
173172
</td>
174173
<td style="text-align:center">
175-
<a href='https://app.cortexcpp.com/download/nightly/mac-universal-local'>
174+
<a href='https://app.cortexcpp.com/download/nightly/mac-universal-network'>
176175
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
177-
<b>cortex-local-installer.pkg</b>
176+
<b>cortex-nightly-mac-network-installer.pkg</b>
178177
</a>
179178
</td>
180179
<td style="text-align:center">
181-
<a href='https://app.cortexcpp.com/download/nightly/linux-amd64-local'>
182-
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
183-
<b>cortex-local-installer.deb</b>
180+
<a href='https://app.cortexcpp.com/download/nightly/linux-amd64-network'>
181+
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:15px; width: 15px" />
182+
<b>cortex-nightly-linux-network-installer.deb</b>
184183
</a>
185184
</td>
186185
</tr>
187186
</table>
188187

189-
### Network Installer
190-
191-
Cortex.cpp is available with a Network Installer, which is a smaller installer but requires internet connection during installation to download the necessary dependencies.
192-
188+
#### Local Installer
193189
<table>
194190
<tr style="text-align:center">
195191
<td style="text-align:center"><b>Version Type</b></td>
196192
<td style="text-align:center"><b>Windows</b></td>
197193
<td style="text-align:center"><b>MacOS</b></td>
198194
<td style="text-align:center"><b>Linux</b></td>
199195
</tr>
200-
<tr style="text-align:center">
201-
<td style="text-align:center"><b>Stable (Recommended)</b></td>
202-
<td style="text-align:center">
203-
<a href='https://app.cortexcpp.com/download/latest/windows-amd64-network'>
204-
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
205-
<b>cortex-network-installer.exe</b>
206-
</a>
207-
<td style="text-align:center">
208-
<a href='https://app.cortexcpp.com/download/latest/mac-universal-network'>
209-
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
210-
<b>cortex-network-installer.pkg</b>
211-
</a>
212-
</td>
213-
<td style="text-align:center">
214-
<a href='https://app.cortexcpp.com/download/latest/linux-amd64-network'>
215-
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
216-
<b>cortex-network-installer.deb</b>
217-
</a>
218-
</td>
219-
</tr>
220196
<tr style="text-align:center">
221197
<td style="text-align:center"><b>Beta (Preview)</b></td>
222198
<td style="text-align:center">
223-
<a href='https://app.cortexcpp.com/download/beta/windows-amd64-network'>
199+
<a href='https://app.cortexcpp.com/download/beta/windows-amd64-local'>
224200
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
225-
<b>cortex-network-installer.exe</b>
201+
<b>cortex-beta-windows-local-installer.exe</b>
226202
</a>
227203
</td>
228204
<td style="text-align:center">
229-
<a href='https://app.cortexcpp.com/download/beta/mac-universal-network'>
205+
<a href='https://app.cortexcpp.com/download/beta/mac-universal-local'>
230206
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
231-
<b>cortex-network-installer.pkg</b>
207+
<b>cortex-beta-mac-local-installer.pkg</b>
232208
</a>
233209
</td>
234210
<td style="text-align:center">
235-
<a href='https://app.cortexcpp.com/download/beta/linux-amd64-network'>
211+
<a href='https://app.cortexcpp.com/download/beta/linux-amd64-local'>
236212
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
237-
<b>cortex-network-installer.deb</b>
213+
<b>cortex-beta-linux-local-installer.deb</b>
238214
</a>
239215
</td>
240216
</tr>
241217
<tr style="text-align:center">
242-
<td style="text-align:center"><b>Nightly Build (Experimental)</b></td>
218+
<td style="text-align:center"><b>Nightly (Experimental)</b></td>
243219
<td style="text-align:center">
244-
<a href='https://app.cortexcpp.com/download/nightly/windows-amd64-network'>
220+
<a href='https://app.cortexcpp.com/download/nightly/windows-amd64-local'>
245221
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
246-
<b>cortex-network-installer.exe</b>
222+
<b>cortex-nightly-windows-local-installer.exe</b>
247223
</a>
248224
</td>
249225
<td style="text-align:center">
250-
<a href='https://app.cortexcpp.com/download/nightly/mac-universal-network'>
226+
<a href='https://app.cortexcpp.com/download/nightly/mac-universal-local'>
251227
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
252-
<b>cortex-network-installer.pkg</b>
228+
<b>cortex-nightly-mac-local-installer.pkg</b>
253229
</a>
254230
</td>
255231
<td style="text-align:center">
256-
<a href='https://app.cortexcpp.com/download/nightly/linux-amd64-network'>
232+
<a href='https://app.cortexcpp.com/download/nightly/linux-amd64-local'>
257233
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
258-
<b>cortex-network-installer.deb</b>
234+
<b>cortex-nightly-linux-local-installer.deb</b>
259235
</a>
260236
</td>
261237
</tr>

0 commit comments

Comments
 (0)