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

Commit 6a36e90

Browse files
committed
docs: update cortex folder session
1 parent bd740a0 commit 6a36e90

File tree

2 files changed

+44
-94
lines changed

2 files changed

+44
-94
lines changed

docs/docs/architecture/cortexrc.mdx

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,32 +14,42 @@ 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

19-
- **Windows**:
20-
- Stable: `C:\Users\<username>\.cortexrc`
21-
- Beta: `C:\Users\<username>\.cortexrc-beta`
22-
- Nighty: `C:\Users\<username>\.cortexrc-nightly`
23-
- **Linux**:
24-
- Stable: `/home/<username>/.cortexrc`
25-
- Beta: `/home/<username>/.cortexrc-beta`
26-
- Nighty: `/home/<username>/.cortexrc-nightly`
27-
- **macOS**:
28-
- Stable: `/Users/<username>/.cortexrc`
29-
- Beta: `/Users/<username>/.cortexrc-beta`
30-
- Nighty: `/Users/<username>/.cortexrc-nightly`
20+
- **Windows**: `C:\Users\<username>\.cortexrc`
21+
- **Linux**: `/home/<username>/.cortexrc`
22+
- **macOS**: `/Users/<username>/.cortexrc`
3123

3224
## Configuration Parameters
25+
3326
You can configure the following parameters in the `.cortexrc` file:
34-
| Parameter | Description | Default Value |
27+
| Parameter | Description | Default Value |
3528
|------------------|--------------------------------------------------|--------------------------------|
36-
| `dataFolderPath` | Path to the folder where `.cortexrc` located. | User's home folder. |
37-
| `apiServerHost` | Host address for the Cortex.cpp API server. | `127.0.0.1` |
38-
| `apiServerPort` | Port number for the Cortex.cpp API server. | `39281` |
29+
| `dataFolderPath` | Path to the folder where `.cortexrc` located. | User's home folder. |
30+
| `apiServerHost` | Host address for the Cortex.cpp API server. | `127.0.0.1` |
31+
| `apiServerPort` | Port number for the Cortex.cpp API server. | `39281` |
32+
| `logFolderPath` | Path to the folder where Cortex.cpp logs are stored. | `C:\Users\<username>\cortexcpp-nightly` |
33+
| `logLlamaCppPath` | Path to the folder where LlamaCpp logs are stored. | `./logs/cortex.log` |
34+
| `logTensorrtLLMPath` | Path to the folder where TensorRT logs are stored. | `./logs/cortex.log` |
35+
| `logOnnxPath` | Path to the folder where ONNX logs are stored. | `./logs/cortex.log` |
36+
| `maxLogLines` | Maximum number of lines in the log file. | `100000` |
37+
| `checkedForUpdateAt` | Timestamp of the last update check. | `0` |
38+
| `latestRelease` | Latest release version. | `""` |
39+
| `huggingFaceToken` | Hugging Face API token. Use to download private models from Hugging Face. | `""` |
3940

4041
Example of the `.cortexrc` file:
42+
4143
```
42-
dataFolderPath: /Users/<username>/cortexcpp
44+
logFolderPath: C:\Users\<username>\cortexcpp
45+
logLlamaCppPath: ./logs/cortex.log
46+
logTensorrtLLMPath: ./logs/cortex.log
47+
logOnnxPath: ./logs/cortex.log
48+
dataFolderPath: C:\Users\username\cortexcpp
49+
maxLogLines: 100000
4350
apiServerHost: 127.0.0.1
4451
apiServerPort: 39281
45-
```
52+
checkedForUpdateAt: 1730363971
53+
latestRelease: v1.0.1
54+
huggingFaceToken: ""
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.

0 commit comments

Comments
 (0)