Skip to content

Cortex Configs

This command allows you to customize the Cortex’s configurations.

Usage:

Terminal window
cortex configs [options]

Options:

OptionDescriptionRequiredDefault valueExample
-h, --helpDisplay help information for the command.No--h

cortex configs get

This command returns a config detail defined by a config name.

Usage:

Terminal window
cortex configs get <name>

For example, it returns the following:

Terminal window
┌─────────┬────────┐
(index) │ Values │
├─────────┼────────┤
apiKey ''
└─────────┴────────┘

To get a config name, run the configs list command first.

Options:

OptionDescriptionRequiredDefault valueExample
nameThe name of the config that you want to retrieve.Yes-openai
-h, --helpDisplay help information for the command.No--h

cortex configs list

This command lists all the cortex’s configurations.

Usage:

Terminal window
cortex configs list [options]

For example, it returns the following:

Terminal window
┌────────────────┬────────┬───────────────────────────┐
(index) │ apiKey │ Values │
├────────────────┼────────┼───────────────────────────┤
dataFolderPath 'C:\\Users\\ACER\\cortex'
initialized true
cortexCppHost '127.0.0.1'
cortexCppPort 3929
openai ''
groq ''
mistral ''
anthropic ''
└────────────────┴────────┴───────────────────────────┘

Options:

OptionDescriptionRequiredDefault valueExample
-h, --helpDisplay help information for the command.No--h

cortex configs set

This command sets a specific configuration within Cortex.

Usage:

Terminal window
cortex configs set [options]

Example:

Terminal window
# Set the OpenAI API key
cortex configs set -k apiKey -v yourAPIKey -g openai

Options:

OptionDescriptionRequiredDefault valueExample
-k, --key <key>Configuration key.Yes--k configKey
-v, --value <value>Configuration value.Yes--v configValue
-g, --group <group>Configuration group.Yes--g configGroup
-h, --helpDisplay help information for the command.No--h