You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 4, 2025. It is now read-only.
> ⚠️ **Cortex.cpp is currently in active development. This outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.**
22
23
23
24
## Overview
25
+
24
26
Cortex.cpp is a Local AI engine that is used to run and customize LLMs. Cortex can be deployed as a standalone server, or integrated into apps like [Jan.ai](https://jan.ai/).
25
27
26
28
Cortex.cpp is a multi-engine that uses `llama.cpp` as the default engine but also supports the following:
This Local Installer packages all required dependencies, so that you don’t need an internet connection during the installation process.
33
37
34
38
Alternatively, Cortex is available with a [Network Installer](#network-installer) which downloads the necessary dependencies from the internet during the installation.
| tinyllama | ✅ ||| cortex run tinyllama:1b-gguf |
85
97
86
98
> **Note**:
87
99
> You should have at least 8 GB of RAM available to run the 7B models, 16 GB to run the 14B models, and 32 GB to run the 32B models.
88
100
89
101
## Cortex.cpp CLI Commands
102
+
90
103
For complete details on CLI commands, please refer to our [CLI documentation](https://cortex.so/docs/cli).
91
104
92
105
## REST API
106
+
93
107
Cortex.cpp includes a REST API accessible at `localhost:39281`. For a complete list of endpoints and their usage, visit our [API documentation](https://cortex.so/api-reference).
94
108
95
109
## Advanced Installation
96
110
97
-
### Local Installer: Beta & Nightly Versions
111
+
### Local Installer: Beta & Nightly Versions
112
+
98
113
Beta is an early preview for new versions of Cortex. It is for users who want to try new features early - we appreciate your feedback.
99
114
100
115
Nightly is our development version of Brave. It is released every night and may contain bugs and experimental features.
@@ -172,6 +187,7 @@ Nightly is our development version of Brave. It is released every night and may
172
187
</table>
173
188
174
189
### Network Installer
190
+
175
191
Cortex.cpp is available with a Network Installer, which is a smaller installer but requires internet connection during installation to download the necessary dependencies.
176
192
177
193
<table>
@@ -189,13 +205,13 @@ Cortex.cpp is available with a Network Installer, which is a smaller installer b
5. Use Visual Studio with the C++ development kit to build the project using the files generated in the `build` folder.
318
345
6. Verify that Cortex.cpp is installed correctly by getting help information.
319
346
@@ -323,25 +350,32 @@ cortex
323
350
```
324
351
325
352
## Uninstallation
353
+
326
354
### Windows
355
+
327
356
1. Open the Windows Control Panel.
328
357
2. Navigate to `Add or Remove Programs`.
329
358
3. Search for `cortexcpp` and double click to uninstall. (for beta and nightly builds, search for `cortexcpp-beta` and `cortexcpp-nightly` respectively)
330
359
331
360
### MacOs
361
+
332
362
Run the uninstaller script:
363
+
333
364
```bash
334
365
sudo sh cortex-uninstall.sh
335
366
```
367
+
336
368
For MacOS, there is a uninstaller script comes with the binary and added to the `/usr/local/bin/` directory. The script is named `cortex-uninstall.sh` for stable builds, `cortex-beta-uninstall.sh` for beta builds and `cortex-nightly-uninstall.sh` for nightly builds.
337
369
338
370
### Linux
371
+
339
372
```bash
340
373
# For stable builds
341
374
sudo apt remove cortexcpp
342
375
```
343
376
344
377
## Contact Support
378
+
345
379
- For support, please file a [GitHub ticket](https://github.com/janhq/cortex.cpp/issues/new/choose).
346
380
- For questions, join our Discord [here](https://discord.gg/FTk2MvZwJH).
347
381
- For long-form inquiries, please email [hello@jan.ai](mailto:hello@jan.ai).
0 commit comments