Linux Installation

warning

🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.

Cortex.cpp Installation

info

Before installation, make sure that you have met the minimum requirements to run Cortex. This instruction is for stable releases. For beta and nightly releases, please replace cortex with cortex-beta and cortex-nightly, respectively.

Prerequisites

• OpenMPI

Install Cortex.cpp

1. Download the Linux installer:

   • From release: https://github.com/janhq/cortex.cpp/releases
   • From quick download links:
     • Local installer .deb:
       • Stable: https://app.cortexcpp.com/download/latest/linux-amd64-local
       • Beta: https://app.cortexcpp.com/download/beta/linux-amd64-local
       • Nightly: https://app.cortexcpp.com/download/nightly/linux-amd64-local
     • Network installer .deb:
       • Stable: https://app.cortexcpp.com/download/latest/linux-amd64-network
       • Beta: https://app.cortexcpp.com/download/beta/linux-amd64-network
       • Nightly: https://app.cortexcpp.com/download/nightly/linux-amd64-network
     • Binary:
       • Stable: https://app.cortexcpp.com/download/latest/linux-amd64-binary
       • Beta: https://app.cortexcpp.com/download/beta/linux-amd64-binary
       • Nightly: https://app.cortexcpp.com/download/nightly/linux-amd64-binary

2. Install Cortex.cpp using the following command:

   
   

   # Installer

   sudo apt install ./cortex-<version>-linux-amd64-network-installer.deb

   # Binary

   tar -xvf cortex-<version>-linux-amd64.tar.gz

   cd cortex

   sudo mv cortex /usr/bin/cortex

   sudo chmod +x /usr/bin/Cortexs

   sudo mv cortex-server /usr/bin/cortex-server

   ## For binary, you need to install engine manually after extracting the binary

   cortex engines install llama-cpp

   
   

3. Ensure that Cortex.cpp is sucessfulyy installed:

   
   

   # Stable

   cortex -v

   
   

Data Folder

By default, Cortex.cpp is installed in the following directory:

# Binary Location

/usr/bin/cortex

/usr/bin/cortex-server

# Application Data (Engines, Models and Logs folders)

/home/<username>/cortexcpp

# Configuration File

/home/<username>/.cortexrc

Uninstall Cortex.cpp

# Stable version

sudo apt remove cortexcpp

Build from Source

Prerequisites

• OpenMPI
• CMake >= 3.10
• gcc/g++ >= 9
• ninja-build
• make-gnu

Build Cortex.cpp

1. Clone the Cortex Repository

   
   

   git clone https://github.com/janhq/cortex.cpp.git

   cd cortex.cpp

   git submodule update --init

   
   

2. Build the Cortex.cpp :

   
   

   cd engine

   make configure-vcpkg

   make build CMAKE_EXTRA_FLAGS="-DCORTEX_CPP_VERSION=$(git rev-parse HEAD) -DCMAKE_BUILD_TEST=OFF -DCMAKE_TOOLCHAIN_FILE=vcpkg/scripts/buildsystems/vcpkg.cmake"

   
   

3. Verify that Cortex.cpp is builded correctly by getting help information.

   
   

   # Get the help information

   ./build/cortex -h

   
   

Update cortex to latest version

info

The script requires sudo permission. Supported for debians based systems only (Ubuntu, Debian, etc).

sudo cortex update