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

Commit 26abd53

Browse files
authored
docs: Update README.md (#767)
1 parent fd9d8c3 commit 26abd53

File tree

1 file changed

+16
-72
lines changed

1 file changed

+16
-72
lines changed

README.md

Lines changed: 16 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cortex - CLI
1+
# Cortex
22
<p align="center">
33
<img alt="cortex-cpplogo" src="https://raw.githubusercontent.com/janhq/cortex/dev/assets/cortex-banner.png">
44
</p>
@@ -11,86 +11,27 @@
1111
> ⚠️ **Cortex is currently in Development**: Expect breaking changes and bugs!
1212
1313
## About
14-
Cortex is an openAI-compatible local AI server that developers can use to build LLM apps. It is packaged with a Docker-inspired command-line interface and a Typescript client library. It can be used as a standalone server, or imported as a library.
14+
Cortex is an OpenAI-compatible AI engine that developers can use to build LLM apps. It is packaged with a Docker-inspired command-line interface and client libraries. It can be used as a standalone server or imported as a library.
1515

16-
Cortex currently supports two inference engines:
16+
Cortex currently supports 3 inference engines:
1717

1818
- Llama.cpp
19+
- ONNX Runtime
1920
- TensorRT-LLM
2021

21-
> Read more about Cortex at https://jan.ai/cortex
22-
2322
## Quicklinks
24-
**Cortex**:
25-
- [Website](https://jan.ai/)
26-
- [GitHub](https://github.com/janhq/cortex)
27-
- [User Guides](https://jan.ai/cortex)
28-
- [API reference](https://jan.ai/api-reference)
29-
30-
## Prerequisites
31-
32-
### **Dependencies**
33-
34-
Before installation, ensure that you have installed the following:
35-
36-
- **Node.js**: version 18 and above is required to run the installation.
37-
- **NPM**: Needed to manage packages.
38-
- **CPU Instruction Sets**: Available for download from the [Cortex GitHub Releases](https://github.com/janhq/cortex/releases) page.
39-
40-
41-
>💡 The **CPU instruction sets** are not required for the initial installation of Cortex. This dependency will be automatically installed during the Cortex initialization if they are not already on your system.
4223

43-
44-
### **Hardware**
45-
46-
Ensure that your system meets the following requirements to run Cortex:
47-
48-
- **OS**:
49-
- MacOSX 13.6 or higher.
50-
- Windows 10 or higher.
51-
- Ubuntu 12.04 and later.
52-
- **RAM (CPU Mode):**
53-
- 8GB for running up to 3B models.
54-
- 16GB for running up to 7B models.
55-
- 32GB for running up to 13B models.
56-
- **VRAM (GPU Mode):**
57-
58-
- 6GB can load the 3B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
59-
- 8GB can load the 7B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
60-
- 12GB can load the 13B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
61-
62-
- **Disk**: At least 10GB for app and model download.
24+
- [Homepage](https://cortex.jan.ai/)
25+
- [Docs](https://cortex.jan.ai/docs/)
6326

6427
## Quickstart
65-
To install Cortex CLI, follow the steps below:
66-
1. Install the Cortex NPM package globally:
67-
``` bash
68-
npm i -g @janhq/cortex
69-
```
70-
> Cortex automatically detects your CPU and GPU, downloading the appropriate CPU instruction sets and required dependencies to optimize GPU performance.
71-
2. Download a GGUF model from Hugging Face:
72-
``` bash
73-
# Pull a model most compatible with your hardware
74-
cortex pull llama3
75-
76-
# Pull a specific variant with `repo_name:branch`
77-
cortex pull llama3:7b
7828

79-
# Pull a model with the HuggingFace `model_id`
80-
cortex pull microsoft/Phi-3-mini-4k-instruct-gguf
81-
```
82-
3. Load the model:
83-
``` bash
84-
cortex models start llama3:7b
85-
```
29+
Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started.
8630

87-
4. Start chatting with the model:
8831
``` bash
89-
cortex chat tell me a joke
32+
npm i -g @janhq/cortex
33+
cortex run llama3
9034
```
91-
92-
93-
## Run as an API server
9435
To run Cortex as an API server:
9536
```bash
9637
cortex serve
@@ -120,9 +61,10 @@ chmod +x '[path-to]/cortex/cortex-js/dist/src/command.js'
12061
npm link
12162
```
12263

123-
## Cortex CLI Command
124-
The following CLI commands are currently available:
125-
> ⚠️ **Cortex is currently in Development**: More commands will be added soon!
64+
## Cortex CLI Commands
65+
66+
The following CLI commands are currently available.
67+
See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information.
12668

12769
```bash
12870

@@ -142,6 +84,7 @@ The following CLI commands are currently available:
14284
models stop Stop a specified model.
14385
models update Update the configuration of a specified model.
14486
```
87+
14588
## Uninstall Cortex
14689
14790
Run the following command to uninstall Cortex globally on your machine:
@@ -150,7 +93,8 @@ Run the following command to uninstall Cortex globally on your machine:
15093
# Uninstall globally using NPM
15194
npm uninstall -g @janhq/cortex
15295
```
96+
15397
## Contact Support
15498
- For support, please file a GitHub ticket.
15599
- For questions, join our Discord [here](https://discord.gg/FTk2MvZwJH).
156-
- For long-form inquiries, please email [hello@jan.ai](mailto:hello@jan.ai).
100+
- For long-form inquiries, please email [hello@jan.ai](mailto:hello@jan.ai).

0 commit comments

Comments
 (0)