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

Commit 39509bc

Browse files
author
Gabrielle Ong
authored
Merge pull request #1629 from janhq/feat/cli-docs-models-engines
chore: clean up models and engines, to refactor into separate pages
2 parents f2de4b7 + c4b2759 commit 39509bc

File tree

2 files changed

+59
-388
lines changed

2 files changed

+59
-388
lines changed

‎docs/docs/cli/engines/index.mdx‎

Lines changed: 38 additions & 155 deletions
Original file line numberDiff line numberDiff line change
@@ -5,43 +5,21 @@ title: Cortex Engines
55
import Tabs from "@theme/Tabs";
66
import TabItem from "@theme/TabItem";
77

8-
:::warning
9-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
10-
:::
11-
128
# `cortex engines`
139

1410
This command allows you to manage various engines available within Cortex.
1511

1612

17-
1813
**Usage**:
19-
:::info
20-
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]`.
21-
:::
2214
<Tabs>
2315
<TabItem value="MacOs/Linux" label="MacOs/Linux">
2416
```sh
25-
# Stable
2617
cortex engines [options] [subcommand]
27-
28-
# Beta
29-
cortex-beta engines [options] [subcommand]
30-
31-
# Nightly
32-
cortex-nightly engines [options] [subcommand]
3318
```
3419
</TabItem>
3520
<TabItem value="Windows" label="Windows">
3621
```sh
37-
# Stable
3822
cortex.exe engines [options] [subcommand]
39-
40-
# Beta
41-
cortex-beta.exe engines [options] [subcommand]
42-
43-
# Nightly
44-
cortex-nightly.exe engines [options] [subcommand]
4523
```
4624
</TabItem>
4725
</Tabs>
@@ -54,127 +32,85 @@ You can use the `--verbose` flag to display more detailed output of the internal
5432
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
5533
{/* | `-vk`, `--vulkan` | Install Vulkan engine. | No | `false` | `-vk` | */}
5634

57-
## `cortex engines get`
35+
---
36+
# Subcommands:
37+
## `cortex engines list`
5838
:::info
5939
This CLI command calls the following API endpoint:
60-
- [Get Engine](/api-reference#tag/engines/get/v1/engines/{name})
40+
- [List Engines](/api-reference#tag/engines/get/v1/engines)
6141
:::
62-
This command returns an engine detail defined by an engine `engine_name`.
42+
This command lists all the Cortex's engines.
6343

6444

6545

6646
**Usage**:
67-
:::info
68-
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]`.
69-
:::
7047
<Tabs>
7148
<TabItem value="MacOs/Linux" label="MacOs/Linux">
7249
```sh
73-
# Stable
74-
cortex engines get <engine_name>
75-
76-
# Beta
77-
cortex-beta engines get <engine_name>
78-
79-
# Nightly
80-
cortex-nightly engines get <engine_name>
50+
cortex engines list
8151
```
8252
</TabItem>
8353
<TabItem value="Windows" label="Windows">
8454
```sh
85-
# Stable
86-
cortex.exe engines get <engine_name>
87-
88-
# Beta
89-
cortex-beta.exe engines get <engine_name>
90-
91-
# Nightly
92-
cortex-nightly.exe engines get <engine_name>
55+
cortex.exe engines list
9356
```
9457
</TabItem>
9558
</Tabs>
9659

9760
For example, it returns the following:
98-
```bash
99-
┌─────────────┬────────────────────────────────────────────────────────────────────────────┐
100-
│ (index) │ Values │
101-
├─────────────┼────────────────────────────────────────────────────────────────────────────┤
102-
│ name │ 'onnx' │
103-
│ description │ 'This extension enables chat completion API calls using the Cortex engine' │
104-
│ version │ '0.0.1' │
105-
│ productName │ 'Cortex Inference Engine' │
106-
└─────────────┴────────────────────────────────────────────────────────────────────────────┘
10761
```
108-
:::info
109-
To get an engine name, run the [`engines list`](/docs/cli/engines/list) command first.
110-
:::
111-
112-
113-
**Options**:
114-
115-
| Option | Description | Required | Default value | Example |
116-
|-------------------|-------------------------------------------------------|----------|---------------|-----------------|
117-
| `engine_name` | The name of the engine that you want to retrieve. | Yes | - | `llama-cpp`|
118-
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
62+
+---+--------------+-------------------+---------+----------------------------+---------------+
63+
| # | Name | Supported Formats | Version | Variant | Status |
64+
+---+--------------+-------------------+---------+----------------------------+---------------+
65+
| 1 | onnxruntime | ONNX | | | Incompatible |
66+
+---+--------------+-------------------+---------+----------------------------+---------------+
67+
| 2 | llama-cpp | GGUF | 0.1.34 | linux-amd64-avx2-cuda-12-0 | Ready |
68+
+---+--------------+-------------------+---------+----------------------------+---------------+
69+
| 3 | tensorrt-llm | TensorRT Engines | | | Not Installed |
70+
+---+--------------+-------------------+---------+----------------------------+---------------+
71+
```
11972

120-
## `cortex engines list`
73+
## `cortex engines get`
12174
:::info
12275
This CLI command calls the following API endpoint:
123-
- [List Engines](/api-reference#tag/engines/get/v1/engines)
76+
- [Get Engine](/api-reference#tag/engines/get/v1/engines/{name})
12477
:::
125-
This command lists all the Cortex's engines.
126-
127-
78+
This command returns an engine detail defined by an engine `engine_name`.
12879

12980
**Usage**:
130-
:::info
131-
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]`.
132-
:::
13381
<Tabs>
13482
<TabItem value="MacOs/Linux" label="MacOs/Linux">
13583
```sh
136-
# Stable
137-
cortex engines list [options]
138-
139-
# Beta
140-
cortex-beta engines list [options]
141-
142-
# Nightly
143-
cortex-nightly engines list [options]
84+
cortex engines get <engine_name>
14485
```
14586
</TabItem>
14687
<TabItem value="Windows" label="Windows">
14788
```sh
148-
# Stable
149-
cortex.exe engines list [options]
150-
151-
# Beta
152-
cortex-beta.exe engines list [options]
153-
154-
# Nightly
155-
cortex-nightly.exe engines list [options]
89+
cortex.exe engines get <engine_name>
15690
```
15791
</TabItem>
15892
</Tabs>
15993

16094
For example, it returns the following:
161-
```bash
162-
+---+--------------+-------------------+---------+----------------------------+---------------+
163-
| # | Name | Supported Formats | Version | Variant | Status |
164-
+---+--------------+-------------------+---------+----------------------------+---------------+
165-
| 1 | onnxruntime | ONNX | | | Incompatible |
166-
+---+--------------+-------------------+---------+----------------------------+---------------+
167-
| 2 | llama-cpp | GGUF | 0.1.34 | linux-amd64-avx2-cuda-12-0 | Ready |
168-
+---+--------------+-------------------+---------+----------------------------+---------------+
169-
| 3 | tensorrt-llm | TensorRT Engines | | | Not Installed |
170-
+---+--------------+-------------------+---------+----------------------------+---------------+
17195
```
96+
+-----------+-------------------+---------+-----------+--------+
97+
| Name | Supported Formats | Version | Variant | Status |
98+
+-----------+-------------------+---------+-----------+--------+
99+
| llama-cpp | GGUF | 0.1.37 | mac-arm64 | Ready |
100+
+-----------+-------------------+---------+-----------+--------+
101+
```
102+
:::info
103+
To get an engine name, run the [`engines list`](/docs/cli/engines/list) command.
104+
:::
105+
172106

173107
**Options**:
174108

175-
| Option | Description | Required | Default value | Example |
176-
|---------------------------|----------------------------------------------------|----------|---------------|----------------------|
177-
| `-h`, `--help` | Display help for command. | No | - | `-h` |
109+
| Option | Description | Required | Default value | Example |
110+
|-------------------|-------------------------------------------------------|----------|---------------|-----------------|
111+
| `engine_name` | The name of the engine that you want to retrieve. | Yes | - | `llama-cpp`|
112+
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
113+
178114

179115

180116
## `cortex engines install`
@@ -188,87 +124,41 @@ This command downloads the required dependencies and installs the engine within
188124
- `tensorrt-llm`
189125

190126
**Usage**:
191-
:::info
192-
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]`.
193-
:::
194127
<Tabs>
195128
<TabItem value="MacOs/Linux" label="MacOs/Linux">
196129
```sh
197-
# Stable
198130
cortex engines install [options] <engine_name>
199-
200-
# Beta
201-
cortex-beta engines install [options] <engine_name>
202-
203-
# Nightly
204-
cortex-nightly engines install [options] <engine_name>
205131
```
206132
</TabItem>
207133
<TabItem value="Windows" label="Windows">
208134
```sh
209-
# Stable
210135
cortex.exe engines install [options] <engine_name>
211-
212-
# Beta
213-
cortex-beta.exe engines install [options] <engine_name>
214136

215-
# Nightly
216-
cortex-nightly.exe engines install [options] <engine_name>
217137
```
218138
</TabItem>
219139
</Tabs>
220140

221-
For Example:
222-
```bash
223-
## Llama.cpp engine
224-
cortex engines install llama-cpp
225-
226-
## ONNX engine
227-
cortex engines install onnxruntime
228-
229-
## Tensorrt-LLM engine
230-
cortex engines install tensorrt-llm
231-
232-
```
233-
234141
**Options**:
235142

236143
| Option | Description | Required | Default value | Example |
237144
|---------------------------|----------------------------------------------------|----------|---------------|----------------------|
238-
| `engine_name` | The name of the engine you want to install. | Yes | - | - |
145+
| `engine_name` | The name of the engine you want to install. | Yes | `llama-cpp`, `onnxruntime`, `tensorrt-llm` | - |
239146
| `-h`, `--help` | Display help for command. | No | - | `-h` |
240147

241148
## `cortex engines uninstall`
242149

243150
This command uninstalls the engine within Cortex.
244151

245152
**Usage**:
246-
:::info
247-
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]`.
248-
:::
249153
<Tabs>
250154
<TabItem value="MacOs/Linux" label="MacOs/Linux">
251155
```sh
252-
# Stable
253156
cortex engines uninstall [options] <engine_name>
254-
255-
# Beta
256-
cortex-beta engines uninstall [options] <engine_name>
257-
258-
# Nightly
259-
cortex-nightly engines uninstall [options] <engine_name>
260157
```
261158
</TabItem>
262159
<TabItem value="Windows" label="Windows">
263160
```sh
264-
# Stable
265161
cortex.exe engines uninstall [options] <engine_name>
266-
267-
# Beta
268-
cortex-beta.exe engines uninstall [options] <engine_name>
269-
270-
# Nightly
271-
cortex-nightly.exe engines uninstall [options] <engine_name>
272162
```
273163
</TabItem>
274164
</Tabs>
@@ -277,13 +167,6 @@ For Example:
277167
```bash
278168
## Llama.cpp engine
279169
cortex engines uninstall llama-cpp
280-
281-
## ONNX engine
282-
cortex engines uninstall onnxruntime
283-
284-
## Tensorrt-LLM engine
285-
cortex engines uninstall tensorrt-llm
286-
287170
```
288171

289172
**Options**:

0 commit comments

Comments
 (0)