Mac Installation

info

Before installation, make sure that you have met the minimum requirements to run Cortex. The instructions below are for stable releases only. For beta and nightly releases, please replace cortex with cortex-beta and cortex-nightly, respectively.

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/mac-universal-local
    • Beta: https://app.cortexcpp.com/download/beta/mac-universal-local
    • Nightly: https://app.cortexcpp.com/download/nightly/mac-universal-local
  • Network installer .deb:
    • Stable: https://app.cortexcpp.com/download/latest/mac-universal-network
    • Beta: https://app.cortexcpp.com/download/beta/mac-universal-network
    • Nightly: https://app.cortexcpp.com/download/nightly/mac-universal-network
  • Binary:
    • Stable: https://app.cortexcpp.com/download/latest/mac-universal-binary
    • Beta: https://app.cortexcpp.com/download/beta/mac-universal-binary
    • Nightly: https://app.cortexcpp.com/download/nightly/mac-universal-binary

2. Install Cortex.cpp by double-clicking the pkg downloaded file.

3. Ensure that Cortex.cpp is sucessfulyy installed:

   
   

   # Stable

   cortex -v

   
   

Data Folder

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

# Binary Location

/usr/local/bin/cortex

/usr/local/bin/cortex-server

/usr/local/bin/cortex-uninstall.sh

The application data which includes Engines, Models and Logs will be installed in your home directory.

/Users/<username>/cortexcpp

The configuration file, .cortexrc, will also be in your home directory.

/Users/<username>/.cortexrc

Uninstall Cortex.cpp

Run the uninstaller script:

sudo sh cortex-uninstall.sh

info

The script requires sudo permission.

Build from Source

Prerequisites

• 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 :

Mac Silicon

cd engine

make configure-vcpkg

make build CMAKE_EXTRA_FLAGS="-DCORTEX_CPP_VERSION=latest -DCMAKE_BUILD_TEST=OFF -DMAC_ARM64=ON -DCMAKE_TOOLCHAIN_FILE=vcpkg/scripts/buildsystems/vcpkg.cmake"

Mac Intel

cd engine

make configure-vcpkg

make build CMAKE_EXTRA_FLAGS="-DCORTEX_CPP_VERSION=latest -DCMAKE_BUILD_TEST=OFF -DCMAKE_TOOLCHAIN_FILE=vcpkg/scripts/buildsystems/vcpkg.cmake"

3. Verify that Cortex.cpp was built correctly by using -h flag to call the help info.

   
   

   # Get the help information

   ./build/cortex -h

   
   

Update Cortex

Cortex can be updated in-place without any additional scripts. In addition, cortex will let you know if there is a new version of itself the next time you start a server.

info

The script requires sudo permission.

sudo cortex update