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

Commit 5be4ec0

Browse files
committed
Cleanup CLI docs (remove chat, sidebar, nightly)
1 parent 8961a0d commit 5be4ec0

File tree

10 files changed

+73
-280
lines changed

10 files changed

+73
-280
lines changed

docs/docs/cli/chat.mdx

Lines changed: 0 additions & 71 deletions
This file was deleted.

docs/docs/cli/cortex.mdx

Lines changed: 8 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,8 @@ slug: /cli
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
12-
:::
13-
14-
# Cortex
15-
This command list all the available commands within the Cortex.cpp commands.
10+
# `cortex`
11+
This command list all the available commands within the Cortex commands.
1612

1713
## Usage
1814
:::info
@@ -21,48 +17,23 @@ You can use the `--verbose` flag to display more detailed output of the internal
2117
<Tabs>
2218
<TabItem value="MacOs/Linux" label="MacOs/Linux">
2319
```sh
24-
# Stable
2520
cortex
26-
27-
# Beta
28-
cortex-beta
29-
30-
# Nightly
31-
cortex-nightly
3221
```
3322
</TabItem>
3423
<TabItem value="Windows" label="Windows">
3524
```sh
36-
# Stable
3725
cortex.exe
38-
39-
# Beta
40-
cortex-beta.exe
41-
42-
# Nightly
43-
cortex-nightly.exe
4426
```
4527
</TabItem>
4628
</Tabs>
4729

48-
49-
## Command Chaining
50-
Cortex CLI's command chaining support allows multiple commands to be executed in sequence with a simplified syntax.
51-
52-
For example:
53-
54-
- [cortex run](/docs/cli/run)
55-
- [cortex chat](/docs/cli/chat)
56-
5730
## Sub Commands
5831

32+
- [cortex start](/docs/cli/start): Start the Cortex API server (starts automatically with other commands)
33+
- [cortex run](/docs/cli/run): Shortcut for `cortex models start`. Pull a remote model or start a local model, and start chatting.
34+
- [cortex pull](/docs/cli/pull): Download a model.
5935
- [cortex models](/docs/cli/models): Manage and configure models.
60-
- [cortex chat](/docs/cli/chat): Send a chat request to a model.
6136
- [cortex ps](/docs/cli/ps): Display active models and their operational status.
62-
- [cortex embeddings](/docs/cli/embeddings): Create an embedding vector representing the input text.
63-
- [cortex engines](/docs/cli/engines): Manage Cortex.cpp engines.
64-
- [cortex pull|download](/docs/cli/pull): Download a model.
65-
- [cortex run](/docs/cli/run): Shortcut to pull, start and chat with a model.
66-
- [cortex update](/docs/cli/update): Update the Cortex.cpp version.
67-
- [cortex start](/docs/cli/start): Start the Cortex.cpp API server.
68-
- [cortex stop](/docs/cli/stop): Stop the Cortex.cpp API server.
37+
- [cortex engines](/docs/cli/engines): Manage Cortex engines.
38+
- [cortex update](/docs/cli/update): Update the Cortex version.
39+
- [cortex stop](/docs/cli/stop): Stop the Cortex API server.

docs/docs/cli/ps.mdx

Lines changed: 14 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,59 +7,42 @@ slug: "ps"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
12-
:::
13-
1410
# `cortex ps`
1511

16-
This command shows the running model and its status.
17-
18-
12+
This command shows the running model and its status (Engine, RAM, VRAM, and Uptime).
1913

2014
## Usage
21-
:::info
22-
You can use the `--verbose` flag to display more detailed output of the internal processes. To apply this flag, use the following format: `cortex --verbose [subcommand]`.
23-
:::
2415
<Tabs>
2516
<TabItem value="MacOs/Linux" label="MacOs/Linux">
2617
```sh
27-
# Stable
2818
cortex ps [options]
29-
30-
# Beta
31-
cortex-beta ps [options]
32-
33-
# Nightly
34-
cortex-nightly ps [options]
3519
```
3620
</TabItem>
3721
<TabItem value="Windows" label="Windows">
3822
```sh
39-
# Stable
4023
cortex.exe ps [options]
41-
42-
# Beta
43-
cortex-beta.exe ps [options]
44-
45-
# Nightly
46-
cortex-nightly.exe ps [options]
4724
```
4825
</TabItem>
4926
</Tabs>
5027

51-
5228
For example, it returns the following table:
5329

5430
```bash
55-
+----------------+-----------+----------+-----------+-----------+
56-
| Model | Engine | RAM | VRAM | Up time |
57-
+----------------+-----------+----------+-----------+-----------+
58-
| tinyllama:gguf | llama-cpp | 35.16 MB | 601.02 MB | 5 seconds |
59-
+----------------+-----------+----------+-----------+-----------+
31+
> cortex ps
32+
+------------------------+-----------+-----------+-----------+-------------------------------+
33+
| Model | Engine | RAM | VRAM | Uptime |
34+
+------------------------+-----------+-----------+-----------+-------------------------------+
35+
| llama3.2:3b-gguf-q4-km | llama-cpp | 308.23 MB | 1.87 GB | 7 seconds |
36+
+------------------------+-----------+-----------+-----------+-------------------------------+
37+
| tinyllama:1b-gguf | llama-cpp | 35.16 MB | 636.18 MB | 1 hour, 5 minutes, 45 seconds |
38+
+------------------------+-----------+-----------+-----------+-------------------------------+
6039
```
6140
## Options
6241

6342
| Option | Description | Required | Default value | Example |
6443
|-------------------|-------------------------------------------------------|----------|---------------|-------------|
65-
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
44+
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
45+
46+
:::info
47+
You can use the `--verbose` flag to display more detailed output of the internal processes. To apply this flag, use the following format: `cortex --verbose [subcommand]`.
48+
:::

docs/docs/cli/pull.mdx

Lines changed: 32 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,23 @@ slug: "pull"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
12-
:::
13-
1410
# `cortex pull`
1511
:::info
1612
This CLI command calls the following API endpoint:
1713
- [Download Model](/api-reference#tag/models/post/v1/models/{modelId}/pull)
1814
:::
19-
This command downloads models from supported [model repositories](/docs/model-sources).
15+
This command displays downloaded models, or displays models available for downloading.
16+
17+
There are 3 ways to download models:
18+
- From Cortex's [Built-in models](/docs/hub/cortex-hub): `cortex pull <model_name>`
19+
- HuggingFace repository handle: `cortex pull <author/RepoID>`
20+
- HuggingFace direct URL: `cortex pull <huggingface URL ending with .gguf>`
21+
22+
Each of these will display the model quantizations available, to be selected for download.
23+
24+
For more information, please refer to [Pulling Models](docs/hub/index).
2025

21-
The downloaded model will be stored in the Cortex folder in your home data directory.
26+
The downloaded model file will be stored in the [Cortex Data Folder](/docs/architecture/data-folder).
2227

2328

2429
## Usage
@@ -28,34 +33,39 @@ You can use the `--verbose` flag to display more detailed output of the internal
2833
<Tabs>
2934
<TabItem value="MacOs/Linux" label="MacOs/Linux">
3035
```sh
31-
# Stable
3236
cortex pull [options] <model_id>
33-
34-
# Beta
35-
cortex-beta pull [options] <model_id>
36-
37-
# Nightly
38-
cortex-nightly pull [options] <model_id>
3937
```
4038
</TabItem>
4139
<TabItem value="Windows" label="Windows">
4240
```sh
43-
# Stable
4441
cortex.exe pull [options] <model_id>
45-
46-
# Beta
47-
cortex-beta.exe pull [options] <model_id>
48-
49-
# Nightly
50-
cortex-nightly.exe pull [options] <model_id>
5142
```
5243
</TabItem>
5344
</Tabs>
5445

46+
For example, this returns the following:
47+
```bash
48+
> cortex-nightly pull llama3.2
49+
Downloaded models:
50+
llama3.2:3b-gguf-q4-km
51+
52+
Available to download:
53+
1. llama3.2:3b-gguf-q2-k
54+
2. llama3.2:3b-gguf-q3-kl
55+
3. llama3.2:3b-gguf-q3-km
56+
4. llama3.2:3b-gguf-q3-ks
57+
5. llama3.2:3b-gguf-q4-ks
58+
6. llama3.2:3b-gguf-q5-km
59+
7. llama3.2:3b-gguf-q5-ks
60+
8. llama3.2:3b-gguf-q6-k
61+
9. llama3.2:3b-gguf-q8-0
62+
63+
Select a model (1-9):
64+
```
5565

5666
## Options
5767

5868
| Option | Description | Required | Default value | Example |
5969
| -------------- | ------------------------------------------------- | -------- | ------------- | ----------- |
60-
| `model_id` | The identifier of the model you want to download. | Yes | - | `mistral` |
61-
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
70+
| `model_id` | The identifier of the model you want to download. You can use the [Built-in models](/docs/hub/cortex-hub) or Supported [HuggingFace models](/docs/hub/hugging-face). | Yes | - | `mistral` |
71+
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |

docs/docs/cli/run.mdx

Lines changed: 10 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -7,75 +7,35 @@ slug: "run"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
12-
:::
13-
1410
# `cortex run`
15-
:::info
16-
This CLI command calls the following API endpoint:
17-
- [Download Model](/api-reference#tag/models/post/v1/models/pull) (The command only calls this endpoint if the specified model is not downloaded yet.)
18-
- Install Engine (The command only calls this endpoint if the specified engine is not downloaded yet.)
19-
- [Start Model](/api-reference#tag/models/post/v1/models/start)
20-
:::
2111

22-
This command facilitates the initiation of starting a specified machine-learning model.
12+
This CLI command is a shortcut to run models easily. It executes this sequence of commands:
13+
1. [`cortex pull`](/docs/cli/models/): This command pulls the specified model if the model is not yet downloaded, or finds a local model.
14+
2. [`cortex engines install`](/docs/cli/engines/): This command installs the specified engines if not yet downloaded.
15+
3. [`cortex models start`](/docs/cli/models/): This command starts the specified model, making it active and ready for interactions.
2316

2417
## Usage
2518
:::info
2619
You can use the `--verbose` flag to display more detailed output of the internal processes. To apply this flag, use the following format: `cortex --verbose [subcommand]`.
2720
:::
21+
2822
<Tabs>
2923
<TabItem value="MacOs/Linux" label="MacOs/Linux">
3024
```sh
31-
# Stable
32-
cortex [options] <model_id>:[engine]
33-
34-
# Beta
35-
cortex-beta [options] <model_id>:[engine]
36-
37-
# Nightly
38-
cortex-nightly [options] <model_id>:[engine]
25+
cortex [options] <model_id>
3926
```
4027
</TabItem>
4128
<TabItem value="Windows" label="Windows">
4229
```sh
43-
# Stable
44-
cortex.exe [options] <model_id>:[engine]
45-
46-
# Beta
47-
cortex-beta.exe [options] <model_id>:[engine]
48-
49-
# Nightly
50-
cortex-nightly.exe [options] <model_id>:[engine]
30+
cortex.exe [options] <model_id>
5131
```
5232
</TabItem>
5333
</Tabs>
5434

55-
### `model_id`
56-
You can use the [Built-in models](/docs/hub/cortex-hub) or Supported [HuggingFace models](/docs/hub/hugging-face).
57-
58-
:::info
59-
This command downloads and installs the model if not already available in your file system, then starts it for interaction.
60-
:::
61-
62-
6335
## Options
6436

6537
| Option | Description | Required | Default value | Example |
6638
|-----------------------------|-----------------------------------------------------------------------------|----------|----------------------------------------------|------------------------|
67-
| `model_id` | The identifier of the model you want to chat with. | Yes | `Prompt to select from the available models` | `mistral` |
68-
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
69-
<!-- | `-t`, `--thread <thread_id>` | Specify the Thread ID. Defaults to creating a new thread if none specified. | No | - | `-t jan_1717650808` |
70-
| `-p`, `--preset` | Apply a chat preset to the chat session. | No | - | `-p friendly` |
71-
| `-c`, `--chat` | Start a chat session after running the model. | No | - | `-c` | -->
72-
73-
74-
75-
## Command Chain
76-
77-
`cortex run` command is a convenience wrapper that automatically executes a sequence of commands to simplify user interactions:
78-
79-
1. [`cortex pull`](/docs/cli/models/): This command pulls the specified model if the model is not yet downloaded.
80-
2. [`cortex engines install`](/docs/cli/engines/): This command installs the specified engines if not yet downloaded.
81-
3. [`cortex models start`](/docs/cli/models/): This command starts the specified model, making it active and ready for interactions.
39+
| `model_id` | The identifier of the model you want to chat with. You can use the [Built-in models](/docs/hub/cortex-hub) or Supported [HuggingFace models](/docs/hub/hugging-face). | Yes | - | `mistral` |
40+
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
41+
<!-- | `-t`, `--thread <thread_id>` | Specify the Thread ID. Defaults to creating a new thread if none specified. | No | - | `-t jan_1717650808` | | `-c` | -->

0 commit comments

Comments
 (0)