feat: Hardware API

docs/docs/capabilities/hardware/index.md → docs/docs/capabilities/hardware/index.mdx

@@ -1,8 +1,13 @@
 ---
 title: Hardware Awareness
-draft: True
+description: The Hardware Awareness section overview
 ---
 
+:::warning
+🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
+:::
+
+
 # Hardware Awareness
 
 Cortex is designed to be hardware aware, meaning it can detect your hardware configuration and automatically set parameters to optimize compatibility and performance, and avoid hardware-related errors.

docs/docs/cli/hardware/index.mdx

@@ -0,0 +1,116 @@
+---
+title: Cortex Hardware
+---
+
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+
+# `cortex hardware`
+
+This command allows you manage and monitor hardware resources.
+
+
+**Usage**:
+:::info
+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]`.
+:::
+<Tabs>
+  <TabItem value="MacOs/Linux" label="MacOs/Linux">
+  ```sh
+  cortex hardware [options] [subcommand]
+  ```
+  </TabItem>
+  <TabItem value="Windows" label="Windows">
+  ```sh
+  cortex.exe hardware [options]
+
+  ```
+  </TabItem>
+</Tabs>
+
+**Options**:
+
+| Option            | Description                                           | Required | Default value | Example         |
+|-------------------|-------------------------------------------------------|----------|---------------|-----------------|
+| `-h`, `--help`    | Display help information for the command.             | No       | -             | `-h`        |
+
+---
+# Subcommands:
+
+## `cortex hardware list`
+:::info
+This CLI command calls the following API endpoint:
+- [List Model](/api-reference#tag/hardware/get/v1/hardware)
+:::
+This command lists all the hardware resources.
+
+**Usage**:
+<Tabs>
+  <TabItem value="MacOs/Linux" label="MacOs/Linux">
+  ```sh
+  cortex hardware list [options]
+  ```
+  </TabItem>
+  <TabItem value="Windows" label="Windows">
+  ```sh
+  cortex.exe hardware list [options]
+  ```
+  </TabItem>
+</Tabs>
+
+For example, it returns the following:
+```bash
+OS Information:
++---+---------------------------+--------------------+
+| # | Version                   | Name               |
++---+---------------------------+--------------------+
+| 1 | 24.04.1 LTS (Noble Numbat)| Ubuntu 24.04.1 LTS |
++---+---------------------------+--------------------+
+```
+
+**Options**:
+
+| Option                    | Description                                        | Required | Default value | Example              |
+|---------------------------|----------------------------------------------------|----------|---------------|----------------------|
+| `-h`, `--help`            | Display help for command.                          | No       | -             | `-h`                 |
+|`--cpu`                    | Display CPU information                            | No       | -             | `--cpu`              |
+|`--os`                     | Display OS information                             | No       | -             | `--os`               |
+|`--ram`                    | Display RAM information                            | No       | -             | `--ram`              |
+|`--storage`                | Display Storage information                        | No       | -             | `--storage`          |
+|`--gpu`                    | Display GPU information                            | No       | -             | `--gpu`              |
+|`--power`                  | Display Power information                          | No       | -             | `--power`            |
+|`--monitors`               | Display Monitors information                       | No       | -             | `--monitors`         |
+
+## `cortex hardware activate`
+
+::info
+This CLI command calls the following API endpoint:
+- [List Model](/api-reference#tag/hardware/post/v1/hardware/activate)
+:::
+This command activates the Cortex's hardware, currently support only GPUs.
+
+**Usage**:
+<Tabs>
+  <TabItem value="MacOs/Linux" label="MacOs/Linux">
+  ```sh
+  cortex hardware activate [options]
+  ```
+  </TabItem>
+  <TabItem value="Windows" label="Windows">
+  ```sh
+  cortex.exe hardware activate [options]
+  ```
+  </TabItem>
+</Tabs>
+
+For example, it returns the following:
+```bash
+Activated GPUs: 0
+```
+
+**Options**:
+
+| Option                    | Description                                        | Required | Default value | Example              |
+|---------------------------|----------------------------------------------------|----------|---------------|----------------------|
+| `-h`, `--help`            | Display help for command.                          | No       | -             | `-h`                 |
+|`--gpus`                   | List of GPUs to activate                           | Yes      | -             | `[0, 1]`             |

docs/docs/cli/models/index.mdx

@@ -157,6 +157,7 @@ This command uses a `model_id` from the model that you have downloaded or availa
 | Option                    | Description                                                               | Required | Default value                                | Example                |
 |---------------------------|---------------------------------------------------------------------------|----------|----------------------------------------------|------------------------|
 | `model_id`                | The identifier of the model you want to start.                            | Yes       | `Prompt to select from the available models` | `mistral`       |
+| `--gpus`                  | List of GPUs to use.                                                      | No       | -                                            | `[0,1]`           |
 | `-h`, `--help`            | Display help information for the command.                                 | No       | -                                            | `-h`               |
 
 ## `cortex models stop`

docs/docs/cli/models/start.md

@@ -12,34 +12,28 @@ description: Cortex models subcommands.
 This command starts a model defined by a `model_id`.
 
 
-
 ## Usage
 
 ```bash
 # Start a model
 cortex models start [model_id]
 
-# Start a model with a preset
-cortex models start [model_id] [options]
-
 # Start with a specified engine
 cortex models start [model_id]:[engine] [options]
 ```
 
 
 :::info
 - This command uses a `model_id` from the model that you have downloaded or available in your file system.
-- Model preset is applied only at the start of the model and does not change during the chat session.
 :::
 
 ## Options
 
-| Option                    | Description                                                               | Required | Default value                                | Example                |
-|---------------------------|---------------------------------------------------------------------------|----------|----------------------------------------------|------------------------|
-| `model_id`                | The identifier of the model you want to start.                            | No       | `Prompt to select from the available models` | `mistral`       |
-| `-a`, `--attach`          | Attach to an interactive chat session.                                    | No       | `false`                                      | `-a`             |
-| `-p`, `--preset <preset>` | Apply a chat preset to the chat session.                                  | No       | `false`                                      | `-p friendly`    |
-| `-h`, `--help`            | Display help information for the command.                                 | No       | -                                            | `-h`               |
+| Option                    | Description                                              | Required | Default value                                | Example           |
+|---------------------------|----------------------------------------------------------|----------|----------------------------------------------|-------------------|
+| `model_id`                | The identifier of the model you want to start.           | No       | `Prompt to select from the available models` | `mistral`         |
+| `--gpus`                  | List of GPUs to use.                                     | No       | -                                            | `[0,1]`           |
+| `-h`, `--help`            | Display help information for the command.                | No       | -                                            | `-h`              |
 
 
 

docs/docs/cli/run.mdx

@@ -37,5 +37,6 @@ You can use the `--verbose` flag to display more detailed output of the internal
 | Option                      | Description                                                                 | Required | Default value                                | Example                |
 |-----------------------------|-----------------------------------------------------------------------------|----------|----------------------------------------------|------------------------|
 | `model_id`                  | The identifier of the model you want to chat with.                          | Yes       | - | `mistral`       |
+| `--gpus`                   | List of GPUs to use.                                                         | No       | -                                            | `[0,1]`           |
 | `-h`, `--help`              | Display help information for the command.                                   | No       | -                                            | `-h`               |
 <!-- | `-t`, `--thread <thread_id>`  | Specify the Thread ID. Defaults to creating a new thread if none specified. | No       | -                                            | `-t jan_1717650808`       |                                      | `-c`               | -->