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.

Cortex

info

This is the initial command you need to run to start using Cortex.cpp.

This command starts the Cortex.cpp process and the API server, which runs on port 1337 by default.

Usage

cortex [command] [options]

Options

Option	Description	Required	Default value	Example
-v, --version	Show version.	No	-	-v
-h, --help	Display help information for the command.	No	-	-h
--verbose	Show the detailed command logs	No	-	--verbose

Command Chaining

Cortex CLI's command chaining support allows multiple commands to be executed in sequence with a simplified syntax.

For example:

• cortex run
• cortex chat

Sub Commands

• cortex models: Manage and configure models.
• cortex chat: Send a chat request to a model.
• cortex ps: Display active models and their operational status.
• cortex embeddings: Create an embedding vector representing the input text.
• cortex engines: Manage Cortex.cpp engines.
• cortex pull|download: Download a model.
• cortex run: Shortcut to start a model and chat.
• cortex update: Update the Cortex.cpp version.