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

Commit 6ed42e0

Browse files
committed
chore: update docs for CLI
1 parent 40a80d0 commit 6ed42e0

File tree

4 files changed

+117
-75
lines changed

4 files changed

+117
-75
lines changed

docs/docs/cli/hardware/activate.mdx

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

docs/docs/cli/hardware/index.mdx

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
title: Cortex Hardware
3+
---
4+
5+
import Tabs from "@theme/Tabs";
6+
import TabItem from "@theme/TabItem";
7+
8+
# `cortex hardware`
9+
10+
This command allows you manage and monitor hardware resources.
11+
12+
13+
**Usage**:
14+
:::info
15+
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]`.
16+
:::
17+
<Tabs>
18+
<TabItem value="MacOs/Linux" label="MacOs/Linux">
19+
```sh
20+
cortex hardware [options] [subcommand]
21+
```
22+
</TabItem>
23+
<TabItem value="Windows" label="Windows">
24+
```sh
25+
cortex.exe hardware [options]
26+
27+
```
28+
</TabItem>
29+
</Tabs>
30+
31+
**Options**:
32+
33+
| Option | Description | Required | Default value | Example |
34+
|-------------------|-------------------------------------------------------|----------|---------------|-----------------|
35+
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
36+
37+
---
38+
# Subcommands:
39+
40+
## `cortex hardware list`
41+
:::info
42+
This CLI command calls the following API endpoint:
43+
- [List Model](/api-reference#tag/hardware/get/v1/hardware)
44+
:::
45+
This command lists all the hardware resources.
46+
47+
**Usage**:
48+
<Tabs>
49+
<TabItem value="MacOs/Linux" label="MacOs/Linux">
50+
```sh
51+
cortex hardware list [options]
52+
```
53+
</TabItem>
54+
<TabItem value="Windows" label="Windows">
55+
```sh
56+
cortex.exe hardware list [options]
57+
```
58+
</TabItem>
59+
</Tabs>
60+
61+
For example, it returns the following:
62+
```bash
63+
OS Information:
64+
+---+---------------------------+--------------------+
65+
| # | Version | Name |
66+
+---+---------------------------+--------------------+
67+
| 1 | 24.04.1 LTS (Noble Numbat)| Ubuntu 24.04.1 LTS |
68+
+---+---------------------------+--------------------+
69+
```
70+
71+
**Options**:
72+
73+
| Option | Description | Required | Default value | Example |
74+
|---------------------------|----------------------------------------------------|----------|---------------|----------------------|
75+
| `-h`, `--help` | Display help for command. | No | - | `-h` |
76+
|`--cpu` | Display CPU information | No | - | `--cpu` |
77+
|`--os` | Display OS information | No | - | `--os` |
78+
|`--ram` | Display RAM information | No | - | `--ram` |
79+
|`--storage` | Display Storage information | No | - | `--storage` |
80+
|`--gpu` | Display GPU information | No | - | `--gpu` |
81+
|`--power` | Display Power information | No | - | `--power` |
82+
|`--monitors` | Display Monitors information | No | - | `--monitors` |
83+
84+
## `cortex hardware activate`
85+
86+
::info
87+
This CLI command calls the following API endpoint:
88+
- [List Model](/api-reference#tag/hardware/post/v1/hardware/activate)
89+
:::
90+
This command activates the Cortex's hardware, currently support only GPUs.
91+
92+
**Usage**:
93+
<Tabs>
94+
<TabItem value="MacOs/Linux" label="MacOs/Linux">
95+
```sh
96+
cortex hardware activate [options]
97+
```
98+
</TabItem>
99+
<TabItem value="Windows" label="Windows">
100+
```sh
101+
cortex.exe hardware activate [options]
102+
```
103+
</TabItem>
104+
</Tabs>
105+
106+
For example, it returns the following:
107+
```bash
108+
Activated GPUs: 0
109+
```
110+
111+
**Options**:
112+
113+
| Option | Description | Required | Default value | Example |
114+
|---------------------------|----------------------------------------------------|----------|---------------|----------------------|
115+
| `-h`, `--help` | Display help for command. | No | - | `-h` |
116+
|`--gpus` | List of GPUs to activate | Yes | - | `[0, 1]` |

docs/docs/cli/hardware/list.mdx

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

docs/docs/cli/models/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ This command uses a `model_id` from the model that you have downloaded or availa
157157
| Option | Description | Required | Default value | Example |
158158
|---------------------------|---------------------------------------------------------------------------|----------|----------------------------------------------|------------------------|
159159
| `model_id` | The identifier of the model you want to start. | Yes | `Prompt to select from the available models` | `mistral` |
160+
| `--gpus` | List of GPUs to use. | No | - | `[0,1]` |
160161
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
161162

162163
## `cortex models stop`

0 commit comments

Comments
 (0)