🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
cortex run
This CLI command calls the following API endpoint:
- Download Model (The command only calls this endpoint if the specified model is not downloaded yet.)
- Install Engine (The command only calls this endpoint if the specified engine is not downloaded yet.)
- Start Model
- Chat Completions (The command makes a call to this endpoint if the
-coption is used.)
This command facilitates the initiation of an interactive chat shell with a specified machine-learning model.
Usage​
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].
- MacOs/Linux
- Windows
# Stablecortex [options] <model_id>:[engine]# Betacortex-beta [options] <model_id>:[engine]# Nightlycortex-nightly [options] <model_id>:[engine]
# Stablecortex.exe [options] <model_id>:[engine]# Betacortex-beta.exe [options] <model_id>:[engine]# Nightlycortex-nightly.exe [options] <model_id>:[engine]
model_id​
You can use the Built-in models or Supported HuggingFace models.
This command downloads and installs the model if not already available in your file system, then starts it for interaction.
Options​
| Option | Description | Required | Default value | Example |
|---|---|---|---|---|
model_id | The identifier of the model you want to chat with. | Yes | Prompt to select from the available models | mistral |
-h, --help | Display help information for the command. | No | - | -h |
Command Chain​
cortex run command is a convenience wrapper that automatically executes a sequence of commands to simplify user interactions:
cortex pull: This command pulls the specified model if the model is not yet downloaded.cortex engines install: This command installs the specified engines if not yet downloaded.cortex models start: This command starts the specified model, making it active and ready for interactions.cortex chat: Following model activation, this command opens an interactive chat shell where users can directly communicate with the model.