Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 21 additions & 14 deletions docs/docs/architecture/cortexrc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,30 +16,37 @@ Cortex.cpp supports reading its configuration from a file called `.cortexrc`. Us
## File Location
The configuration file is stored in the following locations:

- **Windows**:
- Stable: `C:\Users\<username>\.cortexrc`
- Beta: `C:\Users\<username>\.cortexrc-beta`
- Nighty: `C:\Users\<username>\.cortexrc-nightly`
- **Linux**:
- Stable: `/home/<username>/.cortexrc`
- Beta: `/home/<username>/.cortexrc-beta`
- Nighty: `/home/<username>/.cortexrc-nightly`
- **macOS**:
- Stable: `/Users/<username>/.cortexrc`
- Beta: `/Users/<username>/.cortexrc-beta`
- Nighty: `/Users/<username>/.cortexrc-nightly`
- **Windows**: `C:\Users\<username>\.cortexrc`
- **Linux**: `/home/<username>/.cortexrc`
- **macOS**: `/Users/<username>/.cortexrc`

## Configuration Parameters
You can configure the following parameters in the `.cortexrc` file:
| Parameter | Description | Default Value |
|------------------|--------------------------------------------------|--------------------------------|
| `dataFolderPath` | Path to the folder where `.cortexrc` located. | User's home folder. |
| `apiServerHost` | Host address for the Cortex.cpp API server. | `127.0.0.1` |
| `apiServerPort` | Port number for the Cortex.cpp API server. | `39281` |
| `apiServerHost` | Host address for the Cortex.cpp API server. | `127.0.0.1` |
| `apiServerPort` | Port number for the Cortex.cpp API server. | `39281` |
| `logFolderPath` | Path the folder where logs are located | User's home folder. |
| `logLlamaCppPath` | The llama-cpp engine . | `./logs/cortex.log` |
| `logTensorrtLLMPath` | The tensorrt-llm engine log file path. | `./logs/cortex.log` |
| `logOnnxPath` | The onnxruntime engine log file path. | `./logs/cortex.log` |
| `maxLogLines` | The maximum log lines that write to file. | `100000` |
| `checkedForUpdateAt` | The last time for checking updates. | `0` |
| `latestRelease` | The lastest release vesion. | Empty string |
| `huggingFaceToken` | HuggingFace token. | Empty string |

Example of the `.cortexrc` file:
```
logFolderPath: /Users/<username>/cortexcpp
logLlamaCppPath: ./logs/cortex.log
logTensorrtLLMPath: ./logs/cortex.log
logOnnxPath: ./logs/cortex.log
dataFolderPath: /Users/<username>/cortexcpp
maxLogLines: 100000
apiServerHost: 127.0.0.1
apiServerPort: 39281
checkedForUpdateAt: 1730501224
latestRelease: v1.0.1
huggingFaceToken: ""
```
Loading