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

Commit 0942fc1

Browse files
author
Gabrielle Ong
authored
Merge pull request #1621 from janhq/docs/installation
Docs: installation
2 parents c44fb59 + a04a93a commit 0942fc1

File tree

8 files changed

+515
-362
lines changed

8 files changed

+515
-362
lines changed

‎docs/docs/architecture/cortexrc.mdx‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,17 @@ import TabItem from "@theme/TabItem";
1414
Cortex.cpp supports reading its configuration from a file called `.cortexrc`. Using this file, you can also change the data folder, Cortex.cpp API server port, and host.
1515

1616
## File Location
17+
1718
The configuration file is stored in the following locations:
1819

1920
- **Windows**: `C:\Users\<username>\.cortexrc`
2021
- **Linux**: `/home/<username>/.cortexrc`
2122
- **macOS**: `/Users/<username>/.cortexrc`
2223

2324
## Configuration Parameters
25+
2426
You can configure the following parameters in the `.cortexrc` file:
25-
| Parameter | Description | Default Value |
27+
| Parameter | Description | Default Value |
2628
|------------------|--------------------------------------------------|--------------------------------|
2729
| `dataFolderPath` | Path to the folder where `.cortexrc` located. | User's home folder. |
2830
| `apiServerHost` | Host address for the Cortex.cpp API server. | `127.0.0.1` |
@@ -37,6 +39,7 @@ You can configure the following parameters in the `.cortexrc` file:
3739
| `huggingFaceToken` | HuggingFace token. | Empty string |
3840

3941
Example of the `.cortexrc` file:
42+
4043
```
4144
logFolderPath: /Users/<username>/cortexcpp
4245
logLlamaCppPath: ./logs/cortex.log
@@ -49,4 +52,4 @@ apiServerPort: 39281
4952
checkedForUpdateAt: 1730501224
5053
latestRelease: v1.0.1
5154
huggingFaceToken: ""
52-
```
55+
```

‎docs/docs/architecture/data-folder.mdx‎

Lines changed: 16 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Data Folder
3-
description: Cortex.cpp's data folder.
2+
title: Data Folder and App Folder
3+
description: Cortex.cpp's data folder and app folder.
44
slug: "data-folder"
55
---
66

@@ -17,37 +17,25 @@ When you install Cortex.cpp, three types of files will be generated on your devi
1717
- **Configuration Files**
1818
- **Data Folder**
1919

20-
## Binary Files
20+
## Binary Files - under the App Folder
2121
These are the executable files of the Cortex.cpp application. The file format varies depending on the operating system:
2222

23-
- **Windows**: `.exe`
24-
- Stable: `C:\Users\<username>\AppData\Local\cortexcpp\cortex.exe`
25-
- Beta: `C:\Users\<username>\AppData\Local\cortexcpp-beta\cortex-beta.exe`
26-
- Nighty: `C:\Users\<username>\AppData\Local\cortexcpp-nightly\cortex-nightly.exe`
27-
- **Linux**: `.deb` or `.fedora`
28-
- Stable: `/usr/bin/cortexcpp`
29-
- Beta: `/usr/bin/cortexcpp-beta`
30-
- Nighty: `/usr/bin/cortexcpp-nightly`
31-
- **macOS**: `.pkg`
32-
- Stable: `/usr/local/bin/cortexcpp`
33-
- Beta: `/home/<username>/.cortexrc-beta`
34-
- Nighty: `/home/<username>/.cortexrc-nightly`
23+
- **Windows**:
24+
- cli: `C:\Users\<username>\AppData\Local\cortexcpp\cortex.exe`
25+
- server: `C:\Users\<username>\AppData\Local\cortexcpp\cortex-server.exe`
26+
- **Linux**:
27+
- cli: `/usr/bin/cortex`
28+
- server: `/usr/bin/cortex-server`
29+
- **macOS**:
30+
- cli: `/usr/local/bin/cortex`
31+
- server: `/usr/local/bin/cortex-server`
3532

3633
## Cortex.cpp Data Folder
3734
The data folder stores the engines, models, and logs required by Cortex.cpp. This folder is located at:
3835

39-
- **Windows**:
40-
- Stable: `C:\Users\<username>\.cortexcpp`
41-
- Beta: `C:\Users\<username>\.cortexcpp-beta`
42-
- Nighty: `C:\Users\<username>\.cortexcpp-nightly`
43-
- **Linux**:
44-
- Stable: `/home/<username>/.cortexcpp<env>`
45-
- Beta: `/home/<username>/.cortexcpp-beta`
46-
- Nighty: `/home/<username>/.cortexcpp-nightly`
47-
- **macOS**:
48-
- Stable: `/Users/<username>\.cortexcpp<env>`
49-
- Beta: `/Users/<username>/.cortexcpp-beta`
50-
- Nighty: `/Users/<username>/.cortexcpp-nightly`
36+
- **Windows**: `C:\Users\<username>\cortexcpp`
37+
- **Linux**: `/home/<username>/cortexcpp`
38+
- **macOS**: `/Users/<username>\cortexcpp`
5139

5240
### Folder Structure
5341
The Cortex.cpp data folder typically follows this structure:
@@ -77,57 +65,9 @@ The Cortex.cpp data folder typically follows this structure:
7765
└── llamacpp
7866
```
7967
</TabItem>
80-
<TabItem value="Beta" label="Beta">
81-
```yaml
82-
~/.cortex-beta
83-
├── models/
84-
│ └── model.list
85-
│ └── huggingface.co/
86-
│ └── <repo_name>/
87-
└── <branch_name>/
88-
└── model.yaml
89-
└── model.gguf
90-
│ └── cortex.so/
91-
│ └── <repo_name>/
92-
│ └── <branch_name>/
93-
└── ...engine_files
94-
└── model.yaml
95-
│ └── imported/
96-
└── imported_model.yaml
97-
├── logs/
98-
│ └── cortex.txt
99-
└── cortex-cli.txt
100-
└── engines/
101-
└── llamacpp
102-
```
103-
</TabItem>
104-
<TabItem value="Nightly" label="Nightly">
105-
```yaml
106-
~/.cortex-nightly
107-
├── models/
108-
│ └── model.list
109-
│ └── huggingface.co/
110-
│ └── <repo_name>/
111-
└── <branch_name>/
112-
└── model.yaml
113-
└── model.gguf
114-
│ └── cortex.so/
115-
│ └── <repo_name>/
116-
│ └── <branch_name>/
117-
└── ...engine_files
118-
└── model.yaml
119-
│ └── imported/
120-
└── imported_model.yaml
121-
├── logs/
122-
│ └── cortex.txt
123-
└── cortex-cli.txt
124-
└── engines/
125-
└── llamacpp
126-
```
127-
</TabItem>
12868
</Tabs>
12969

130-
#### `.cortexcpp<env>`
70+
#### `cortexcpp`
13171
The main directory that stores all Cortex-related files, located in the user's home directory.
13272
#### `models/`
13373
Contains the AI models used by Cortex for processing and generating responses.

‎docs/docs/installation.mdx‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title: Installation
3+
description: Cortex Installation
4+
slug: "installation"
5+
---
6+
7+
import Tabs from '@theme/Tabs';
8+
import TabItem from '@theme/TabItem';
9+
import Admonition from '@theme/Admonition';
10+
11+
:::warning
12+
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
13+
:::
14+
15+
## Cortex.cpp Installation
16+
### Cortex.cpp offers four installer types
17+
- Network Installers download a minimal system and require an internet connection to fetch packages during installation.
18+
- Local Installers include all necessary packages, enabling offline installation without internet access.
19+
- Dockerfile Installers are used to build a Docker image for Cortex.
20+
- Binary files without package management.
21+
22+
### Cortex.cpp supports three channels
23+
24+
- Stable: The latest stable release on github.
25+
- Beta: The release candidate for the next stable release, available on github release with the tag `vx.y.z-rc1`
26+
- Nightly: The nightly build of the latest code on dev branch, available on [discord](https://discord.com/channels/1107178041848909847/1283654073488379904).
27+
28+
For more information, please check out [different channels](#different-channels).
29+
30+
### Download URLs
31+
32+
| Type | Version | Operating System | Download Link |
33+
|----------|---------------|------------------|---------------------------------------------------------------------------------------------------|
34+
| **Local** | **Stable** | **Windows** | [Download](https://app.cortexcpp.com/download/latest/windows-amd64-local) |
35+
| **Local** | **Stable** | **Linux** | [Download](https://app.cortexcpp.com/download/latest/linux-amd64-local) |
36+
| **Local** | **Stable** | **MacOS** | [Download](https://app.cortexcpp.com/download/latest/mac-universal-local) |
37+
38+
:::info
39+
For other versions, please look at [cortex.cpp repo](https://github.com/janhq/cortex.cpp) or each installer page.
40+
:::
41+
42+
43+
## Minimum Requirements
44+
45+
### OS
46+
- MacOS 12 or later
47+
- Windows 10 or later
48+
- Linux: Ubuntu 20.04 or later, Debian 11 or later (For other distributions, please use the Dockerfile installer or binary files, we have not tested on other distributions yet.)
49+
50+
### Hardware
51+
#### CPU
52+
:::info
53+
- Cortex.cpp supports a processor that can handle AVX2. For the full list, please see [here](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#CPUs_with_AVX2).
54+
- We support older processors with AVX, AVX-512 and non-AVX, though this is not recommended.
55+
:::
56+
57+
##### Intel CPU
58+
- Haswell processors (Q2 2013) and newer.
59+
- Tiger Lake (Q3 2020) and newer for Celeron and Pentium processors.
60+
##### AMD CPU
61+
- Excavator processors (Q2 2015) and newer.
62+
63+
#### RAM
64+
:::info
65+
We support DDR2 RAM as the minimum requirement but recommend using newer generations of RAM for improved performance.
66+
:::
67+
- 8GB for running up to 3B models (int4).
68+
- 16GB for running up to 7B models (int4).
69+
- 32GB for running up to 13B models (int4).
70+
71+
#### GPU
72+
:::info
73+
Having at least 6GB VRAM when using NVIDIA, AMD, or Intel Arc GPUs is recommended.
74+
:::
75+
- 6GB can load the 3B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
76+
- 8GB can load the 7B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
77+
- 12GB can load the 13B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
78+
:::info
79+
- [NVIDIA driver](https://www.nvidia.com/Download/index.aspx) version 470.63.01 or higher.
80+
*Note: Users must install the driver by themselves.*
81+
- [CUDA Toolkit](https://developer.nvidia.com/cuda-toolkit) version 12.0 or higher. *Note: Cortex.cpp will automatically detect and install the required version of cudart to the user's machine.*
82+
:::
83+
#### Disk
84+
- At least 10GB for app storage and model download.
85+
86+
## Different channels
87+
88+
Different channels have different features, stability levels, binary file name, app folder and data folder.
89+
90+
### Stable
91+
- App name: `cortexcpp`
92+
- Binary file name: `cortex`, `cortex-server` for linux and mac; `cortex.exe`, `cortex-server.exe` for windows.;
93+
- App folder (Windows Only): `C:\Users\<username>\AppData\Local\cortexcpp`
94+
- Data folder: `~/cortexcpp` for linux and mac; `C:\Users\<username>\cortexcpp` for windows.
95+
- Uninstaller script (Mac Only): `cortex-uninstall.sh`
96+
97+
### Beta
98+
- App name: `cortexcpp-beta`
99+
- Binary file name: `cortex-beta`, `cortex-server-beta` for linux and mac; `cortex-beta.exe`, `cortex-server-beta.exe` for windows.;
100+
- App folder (Windows Only): `C:\Users\<username>\AppData\Local\cortexcpp-beta`
101+
- Data folder: `~/cortexcpp-beta` for linux and mac; `C:\Users\<username>\cortexcpp-beta` for windows.
102+
- Uninstaller script (Mac Only): `cortex-beta-uninstall.sh`
103+
104+
### Nightly
105+
- App name: `cortexcpp-nightly`
106+
- Binary file name: `cortex-nightly`, `cortex-server-nightly` for linux and mac; `cortex-nightly.exe`, `cortex-server-nightly.exe` for windows.;
107+
- App folder (Windows Only): `C:\Users\<username>\AppData\Local\cortexcpp-nightly`
108+
- Data folder: `~/cortexcpp-nightly` for linux and mac; `C:\Users\<username>\cortexcpp-nightly` for windows.
109+
- Uninstaller script (Mac Only): `cortex-nightly-uninstall.sh`

0 commit comments

Comments
 (0)