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

Commit 014c008

Browse files
hiento09hiento09
committed
docs: Add download url
1 parent e60a53c commit 014c008

File tree

1 file changed

+165
-3
lines changed

1 file changed

+165
-3
lines changed

‎README.md‎

Lines changed: 165 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,158 @@ Cortex.cpp is a multi-engine that uses `llama.cpp` as the default engine but als
3030

3131
## Installation
3232

33-
You can install a nightly (unstable) version of Cortex from Discord here: https://discord.gg/nGp6PMrUqS
33+
### Download
34+
35+
<table>
36+
<tr style="text-align:center">
37+
<td style="text-align:center"><b>Version Type</b></td>
38+
<td colspan="2" style="text-align:center"><b>Windows</b></td>
39+
<td colspan="2" style="text-align:center"><b>MacOS</b></td>
40+
<td colspan="2" style="text-align:center"><b>Linux</b></td>
41+
</tr>
42+
<tr style="text-align:center">
43+
<td style="text-align:center"><b>Stable (Recommended)</b></td>
44+
<td style="text-align:center">
45+
<a href='https://github.com/janhq/cortex.cpp'>
46+
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
47+
<b>Coming soon</b>
48+
</a>
49+
</td>
50+
<td style="text-align:center">
51+
<a href='https://github.com/janhq/cortex.cpp'>
52+
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
53+
<b>Coming soon</b>
54+
</a>
55+
</td>
56+
<td style="text-align:center">
57+
<a href='https://github.com/janhq/cortex.cpp'>
58+
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
59+
<b>Coming soon</b>
60+
</a>
61+
</td>
62+
<td style="text-align:center">
63+
<a href='https://github.com/janhq/cortex.cpp'>
64+
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
65+
<b>Coming soon</b>
66+
</a>
67+
</td>
68+
<td style="text-align:center">
69+
<a href='https://github.com/janhq/cortex.cpp'>
70+
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
71+
<b>Coming soon</b>
72+
</a>
73+
</td>
74+
<td style="text-align:center">
75+
<a href='https://github.com/janhq/cortex.cpp'>
76+
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
77+
<b>Coming soon</b>
78+
</a>
79+
</td>
80+
</tr>
81+
<tr style="text-align:center">
82+
<td style="text-align:center"><b>Beta (Preview)</b></td>
83+
<td style="text-align:center">
84+
<a href='https://app.cortexcpp.com/download/beta/windowns-amd64-local'>
85+
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
86+
<b>cortex-local-installer.exe</b>
87+
</a>
88+
</td>
89+
<td style="text-align:center">
90+
<a href='https://app.cortexcpp.com/download/beta/windowns-amd64-network'>
91+
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
92+
<b>cortex-network-installer.exe</b>
93+
</a>
94+
</td>
95+
<td style="text-align:center">
96+
<a href='https://app.cortexcpp.com/download/beta/mac-universal-local'>
97+
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
98+
<b>cortex-local-installer.pkg</b>
99+
</a>
100+
</td>
101+
<td style="text-align:center">
102+
<a href='https://app.cortexcpp.com/download/beta/mac-universal-network'>
103+
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
104+
<b>cortex-network-installer.pkg</b>
105+
</a>
106+
</td>
107+
<td style="text-align:center">
108+
<a href='https://app.cortexcpp.com/download/beta/linux-amd64-local'>
109+
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
110+
<b>cortex-local-installer.deb</b>
111+
</a>
112+
</td>
113+
<td style="text-align:center">
114+
<a href='https://app.cortexcpp.com/download/beta/linux-amd64-network'>
115+
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
116+
<b>cortex-network-installer.deb</b>
117+
</a>
118+
</td>
119+
</tr>
120+
<tr style="text-align:center">
121+
<td style="text-align:center"><b>Nightly Build (Experimental)</b></td>
122+
<td style="text-align:center">
123+
<a href='https://app.cortexcpp.com/download/nightly/windowns-amd64-local'>
124+
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
125+
<b>cortex-local-installer.exe</b>
126+
</a>
127+
</td>
128+
<td style="text-align:center">
129+
<a href='https://app.cortexcpp.com/download/nightly/windowns-amd64-network'>
130+
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
131+
<b>cortex-network-installer.exe</b>
132+
</a>
133+
</td>
134+
<td style="text-align:center">
135+
<a href='https://app.cortexcpp.com/download/nightly/mac-universal-local'>
136+
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
137+
<b>cortex-local-installer.pkg</b>
138+
</a>
139+
</td>
140+
<td style="text-align:center">
141+
<a href='https://app.cortexcpp.com/download/nightly/mac-universal-network'>
142+
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
143+
<b>cortex-network-installer.pkg</b>
144+
</a>
145+
</td>
146+
<td style="text-align:center">
147+
<a href='https://app.cortexcpp.com/download/nightly/linux-amd64-local'>
148+
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
149+
<b>cortex-local-installer.deb</b>
150+
</a>
151+
</td>
152+
<td style="text-align:center">
153+
<a href='https://app.cortexcpp.com/download/nightly/linux-amd64-network'>
154+
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
155+
<b>cortex-network-installer.deb</b>
156+
</a>
157+
</td>
158+
</tr>
159+
</table>
160+
161+
### Instructions
162+
163+
The local installer packages all required dependencies inside the installer itself, so you don’t need an internet connection during the installation process.
164+
The network installer downloads the necessary dependencies from the internet during the installation. This option provides a smaller installer, but requires an internet connection.
165+
166+
After installation, you can run Cortex.cpp from the command line by typing `cortex --help`. For beta and nightly builds, you can run `cortex-beta --help` and `cortex-nightly --help` respectively.
167+
168+
#### Windows and MacOS
169+
170+
Download the installer and double-click to the exe file to start the installation process. Follow the on-screen instructions to complete the installation.
171+
172+
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.
173+
174+
#### Linux
175+
176+
Download the installer and run the following command in the terminal:
177+
178+
```bash
179+
sudo apt install ./cortex-local-installer.deb
180+
# or
181+
sudo apt install ./cortex-network-installer.deb
182+
```
183+
184+
The binary will be installed in the `/usr/bin/` directory.
34185

35186
## Built-in Model Library
36187

@@ -65,18 +216,29 @@ Cortex.cpp includes a REST API accessible at `localhost:3928`. For a complete li
65216
## Uninstallation
66217

67218
### Windows
68-
1. Navigate to `Add or Remove Programs`.
69-
2. Search for Cortex.cpp and click `Uninstall`.
219+
1. Open the Windows Control Panel.
220+
2. Navigate to `Add or Remove Programs`.
221+
3. Search for `cortexcpp` and double click to uninstall. (for beta and nightly builds, search for `cortexcpp-beta` and `cortexcpp-nightly` respectively)
70222

71223
### MacOs
72224
Run the uninstaller script:
73225
```bash
226+
# For stable builds
74227
sudo sh cortex-uninstall.sh
228+
# For beta builds
229+
sudo sh cortex-beta-uninstall.sh
230+
# For nightly builds
231+
sudo sh cortex-nightly-uninstall.sh
75232
```
76233

77234
### Linux
78235
```bash
236+
# For stable builds
79237
sudo apt remove cortexcpp
238+
# For beta builds
239+
sudo apt remove cortexcpp-beta
240+
# For nightly builds
241+
sudo apt remove cortexcpp-nightly
80242
```
81243

82244
### Build from Source

0 commit comments

Comments
 (0)