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

Commit d5d751a

Browse files
authored
chore: cortexrc docs update (#1620)
* chore: cortexrc docs update * chore: default value * chore: comments
1 parent 815c077 commit d5d751a

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

docs/docs/architecture/cortexrc.mdx

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,30 +16,37 @@ Cortex.cpp supports reading its configuration from a file called `.cortexrc`. Us
1616
## File Location
1717
The configuration file is stored in the following locations:
1818

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`
19+
- **Windows**: `C:\Users\<username>\.cortexrc`
20+
- **Linux**: `/home/<username>/.cortexrc`
21+
- **macOS**: `/Users/<username>/.cortexrc`
3122

3223
## Configuration Parameters
3324
You can configure the following parameters in the `.cortexrc` file:
3425
| Parameter | Description | Default Value |
3526
|------------------|--------------------------------------------------|--------------------------------|
3627
| `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` |
28+
| `apiServerHost` | Host address for the Cortex.cpp API server. | `127.0.0.1` |
29+
| `apiServerPort` | Port number for the Cortex.cpp API server. | `39281` |
30+
| `logFolderPath` | Path the folder where logs are located | User's home folder. |
31+
| `logLlamaCppPath` | The llama-cpp engine . | `./logs/cortex.log` |
32+
| `logTensorrtLLMPath` | The tensorrt-llm engine log file path. | `./logs/cortex.log` |
33+
| `logOnnxPath` | The onnxruntime engine log file path. | `./logs/cortex.log` |
34+
| `maxLogLines` | The maximum log lines that write to file. | `100000` |
35+
| `checkedForUpdateAt` | The last time for checking updates. | `0` |
36+
| `latestRelease` | The lastest release vesion. | Empty string |
37+
| `huggingFaceToken` | HuggingFace token. | Empty string |
3938

4039
Example of the `.cortexrc` file:
4140
```
41+
logFolderPath: /Users/<username>/cortexcpp
42+
logLlamaCppPath: ./logs/cortex.log
43+
logTensorrtLLMPath: ./logs/cortex.log
44+
logOnnxPath: ./logs/cortex.log
4245
dataFolderPath: /Users/<username>/cortexcpp
46+
maxLogLines: 100000
4347
apiServerHost: 127.0.0.1
4448
apiServerPort: 39281
49+
checkedForUpdateAt: 1730501224
50+
latestRelease: v1.0.1
51+
huggingFaceToken: ""
4552
```

0 commit comments

Comments
 (0)