diff --git a/docs/docs/architecture/cortexrc.mdx b/docs/docs/architecture/cortexrc.mdx index 312d77986..24dc63a2d 100644 --- a/docs/docs/architecture/cortexrc.mdx +++ b/docs/docs/architecture/cortexrc.mdx @@ -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\\.cortexrc` - - Beta: `C:\Users\\.cortexrc-beta` - - Nighty: `C:\Users\\.cortexrc-nightly` -- **Linux**: - - Stable: `/home//.cortexrc` - - Beta: `/home//.cortexrc-beta` - - Nighty: `/home//.cortexrc-nightly` -- **macOS**: - - Stable: `/Users//.cortexrc` - - Beta: `/Users//.cortexrc-beta` - - Nighty: `/Users//.cortexrc-nightly` +- **Windows**: `C:\Users\\.cortexrc` +- **Linux**: `/home//.cortexrc` +- **macOS**: `/Users//.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//cortexcpp +logLlamaCppPath: ./logs/cortex.log +logTensorrtLLMPath: ./logs/cortex.log +logOnnxPath: ./logs/cortex.log dataFolderPath: /Users//cortexcpp +maxLogLines: 100000 apiServerHost: 127.0.0.1 apiServerPort: 39281 +checkedForUpdateAt: 1730501224 +latestRelease: v1.0.1 +huggingFaceToken: "" ``` \ No newline at end of file