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

docs: Add download url #1431

Merged
merged 1 commit into from
Oct 4, 2024
Merged

docs: Add download url #1431

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 165 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,158 @@ Cortex.cpp is a multi-engine that uses `llama.cpp` as the default engine but als

## Installation

You can install a nightly (unstable) version of Cortex from Discord here: https://discord.gg/nGp6PMrUqS
### Download

<table>
<tr style="text-align:center">
<td style="text-align:center"><b>Version Type</b></td>
<td colspan="2" style="text-align:center"><b>Windows</b></td>
<td colspan="2" style="text-align:center"><b>MacOS</b></td>
<td colspan="2" style="text-align:center"><b>Linux</b></td>
</tr>
<tr style="text-align:center">
<td style="text-align:center"><b>Stable (Recommended)</b></td>
<td style="text-align:center">
<a href='https://github.com/janhq/cortex.cpp'>
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
<b>Coming soon</b>
</a>
</td>
<td style="text-align:center">
<a href='https://github.com/janhq/cortex.cpp'>
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
<b>Coming soon</b>
</a>
</td>
<td style="text-align:center">
<a href='https://github.com/janhq/cortex.cpp'>
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
<b>Coming soon</b>
</a>
</td>
<td style="text-align:center">
<a href='https://github.com/janhq/cortex.cpp'>
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
<b>Coming soon</b>
</a>
</td>
<td style="text-align:center">
<a href='https://github.com/janhq/cortex.cpp'>
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
<b>Coming soon</b>
</a>
</td>
<td style="text-align:center">
<a href='https://github.com/janhq/cortex.cpp'>
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
<b>Coming soon</b>
</a>
</td>
</tr>
<tr style="text-align:center">
<td style="text-align:center"><b>Beta (Preview)</b></td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/beta/windowns-amd64-local'>
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
<b>cortex-local-installer.exe</b>
</a>
</td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/beta/windowns-amd64-network'>
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
<b>cortex-network-installer.exe</b>
</a>
</td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/beta/mac-universal-local'>
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
<b>cortex-local-installer.pkg</b>
</a>
</td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/beta/mac-universal-network'>
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
<b>cortex-network-installer.pkg</b>
</a>
</td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/beta/linux-amd64-local'>
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
<b>cortex-local-installer.deb</b>
</a>
</td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/beta/linux-amd64-network'>
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
<b>cortex-network-installer.deb</b>
</a>
</td>
</tr>
<tr style="text-align:center">
<td style="text-align:center"><b>Nightly Build (Experimental)</b></td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/nightly/windowns-amd64-local'>
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
<b>cortex-local-installer.exe</b>
</a>
</td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/nightly/windowns-amd64-network'>
<img src='https://github.com/janhq/docs/blob/main/static/img/windows.png' style="height:14px; width: 14px" />
<b>cortex-network-installer.exe</b>
</a>
</td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/nightly/mac-universal-local'>
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
<b>cortex-local-installer.pkg</b>
</a>
</td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/nightly/mac-universal-network'>
<img src='https://github.com/janhq/docs/blob/main/static/img/mac.png' style="height:15px; width: 15px" />
<b>cortex-network-installer.pkg</b>
</a>
</td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/nightly/linux-amd64-local'>
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
<b>cortex-local-installer.deb</b>
</a>
</td>
<td style="text-align:center">
<a href='https://app.cortexcpp.com/download/nightly/linux-amd64-network'>
<img src='https://github.com/janhq/docs/blob/main/static/img/linux.png' style="height:14px; width: 14px" />
<b>cortex-network-installer.deb</b>
</a>
</td>
</tr>
</table>

### Instructions

The local installer packages all required dependencies inside the installer itself, so you don’t need an internet connection during the installation process.
The network installer downloads the necessary dependencies from the internet during the installation. This option provides a smaller installer, but requires an internet connection.

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.

#### Windows and MacOS

Download the installer and double-click to the exe file to start the installation process. Follow the on-screen instructions to complete the installation.

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.

#### Linux

Download the installer and run the following command in the terminal:

```bash
sudo apt install ./cortex-local-installer.deb
# or
sudo apt install ./cortex-network-installer.deb
```

The binary will be installed in the `/usr/bin/` directory.

## Built-in Model Library

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

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

### MacOs
Run the uninstaller script:
```bash
# For stable builds
sudo sh cortex-uninstall.sh
# For beta builds
sudo sh cortex-beta-uninstall.sh
# For nightly builds
sudo sh cortex-nightly-uninstall.sh
```

### Linux
```bash
# For stable builds
sudo apt remove cortexcpp
# For beta builds
sudo apt remove cortexcpp-beta
# For nightly builds
sudo apt remove cortexcpp-nightly
```

### Build from Source
Expand Down