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

Commit 9f4e915

Browse files
sangjanaisangjanai
committed
chores: update CLI docs
1 parent 24ad749 commit 9f4e915

File tree

4 files changed

+81
-11
lines changed

4 files changed

+81
-11
lines changed

‎docs/docs/cli/hardware/activate.mdx‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Cortex Hardware Activate
3+
description: Cortex hardware subcommands.
4+
---
5+
6+
:::warning
7+
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
8+
:::
9+
10+
# `cortex hardware activate`
11+
12+
This command activates the Cortex's hardware, currently support only GPUs.
13+
14+
15+
16+
## Usage
17+
18+
```bash
19+
cortex hardware activate [options]
20+
```
21+
For example, it returns the following:
22+
```bash
23+
Activated GPUs: 0
24+
```
25+
26+
## Options
27+
28+
| Option | Description | Required | Default value | Example |
29+
|---------------------------|----------------------------------------------------|----------|---------------|----------------------|
30+
| `-h`, `--help` | Display help for command. | No | - | `-h` |
31+
|`--gpus` | List of GPUs to activate | Yes | - | `[0, 1]` |
32+

‎docs/docs/cli/hardware/list.mdx‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Cortex Hardware List
3+
description: Cortex hardware subcommands.
4+
---
5+
6+
:::warning
7+
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
8+
:::
9+
10+
# `cortex hardware list`
11+
12+
This command lists all the Cortex's hardware.
13+
14+
15+
16+
## Usage
17+
18+
```bash
19+
cortex hardware list [options]
20+
```
21+
For example, it returns the following:
22+
```bash
23+
OS Information:
24+
+---+---------------------------+--------------------+
25+
| # | Version | Name |
26+
+---+---------------------------+--------------------+
27+
| 1 | 24.04.1 LTS (Noble Numbat)| Ubuntu 24.04.1 LTS |
28+
+---+---------------------------+--------------------+
29+
```
30+
31+
## Options
32+
33+
| Option | Description | Required | Default value | Example |
34+
|---------------------------|----------------------------------------------------|----------|---------------|----------------------|
35+
| `-h`, `--help` | Display help for command. | No | - | `-h` |
36+
|`--cpu` | Display CPU information | No | - | `--cpu` |
37+
|`--os` | Display OS information | No | - | `--os` |
38+
|`--ram` | Display RAM information | No | - | `--ram` |
39+
|`--storage` | Display Storage information | No | - | `--storage` |
40+
|`--gpu` | Display GPU information | No | - | `--gpu` |
41+
|`--power` | Display Power information | No | - | `--power` |
42+
|`--monitors` | Display Monitors information | No | - | `--monitors` |
43+

‎docs/docs/cli/models/start.md‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,34 +12,28 @@ description: Cortex models subcommands.
1212
This command starts a model defined by a `model_id`.
1313

1414

15-
1615
## Usage
1716

1817
```bash
1918
# Start a model
2019
cortex models start [model_id]
2120

22-
# Start a model with a preset
23-
cortex models start [model_id] [options]
24-
2521
# Start with a specified engine
2622
cortex models start [model_id]:[engine] [options]
2723
```
2824

2925

3026
:::info
3127
- This command uses a `model_id` from the model that you have downloaded or available in your file system.
32-
- Model preset is applied only at the start of the model and does not change during the chat session.
3328
:::
3429

3530
## Options
3631

37-
| Option | Description | Required | Default value | Example |
38-
|---------------------------|---------------------------------------------------------------------------|----------|----------------------------------------------|------------------------|
39-
| `model_id` | The identifier of the model you want to start. | No | `Prompt to select from the available models` | `mistral` |
40-
| `-a`, `--attach` | Attach to an interactive chat session. | No | `false` | `-a` |
41-
| `-p`, `--preset <preset>` | Apply a chat preset to the chat session. | No | `false` | `-p friendly` |
42-
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
32+
| Option | Description | Required | Default value | Example |
33+
|---------------------------|----------------------------------------------------------|----------|----------------------------------------------|-------------------|
34+
| `model_id` | The identifier of the model you want to start. | No | `Prompt to select from the available models` | `mistral` |
35+
| `--gpus` | List of GPUs to use. | No | - | `[0,1]` |
36+
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
4337

4438

4539

‎docs/docs/cli/run.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,6 @@ You can use the `--verbose` flag to display more detailed output of the internal
3737
| Option | Description | Required | Default value | Example |
3838
|-----------------------------|-----------------------------------------------------------------------------|----------|----------------------------------------------|------------------------|
3939
| `model_id` | The identifier of the model you want to chat with. | Yes | - | `mistral` |
40+
| `--gpus` | List of GPUs to use. | No | - | `[0,1]` |
4041
| `-h`, `--help` | Display help information for the command. | No | - | `-h` |
4142
<!-- | `-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)